Reference documentation and code samples for the Google Cloud Dms V1 Client class DescribeDatabaseEntitiesRequest.
Request message for 'DescribeDatabaseEntities' request.
Generated from protobuf message google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest
Namespace
Google \ Cloud \ CloudDms \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ conversion_workspace
string
Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
↳ page_size
int
Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.
↳ page_token
string
Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.
↳ tree
int
Required. The tree to fetch.
↳ uncommitted
bool
Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.
↳ commit_id
string
Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.
↳ filter
string
Optional. Filter the returned entities based on AIP-160 standard.
↳ view
int
Optional. Results view based on AIP-157
getConversionWorkspace
Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
string
setConversionWorkspace
Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
var
string
$this
getPageSize
Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.
int
setPageSize
Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.
var
int
$this
getPageToken
Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.
string
setPageToken
Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.
var
string
$this
getTree
Required. The tree to fetch.
int
setTree
Required. The tree to fetch.
var
int
$this
getUncommitted
Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.
bool
setUncommitted
Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.
var
bool
$this
getCommitId
Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.
string
setCommitId
Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.
var
string
$this
getFilter
Optional. Filter the returned entities based on AIP-160 standard.
string
setFilter
Optional. Filter the returned entities based on AIP-160 standard.
var
string
$this
getView
Optional. Results view based on AIP-157
int
setView
Optional. Results view based on AIP-157
var
int
$this
