Reference documentation and code samples for the Google Cloud Dms V1 Client class DescribeDatabaseEntitiesRequest.
Request message for 'DescribeDatabaseEntities' request.
Generated from protobuf messagegoogle.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest
Namespace
Google \ Cloud \ CloudDms \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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}.
Returns
Type
Description
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}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of entities to return. The service may return
fewer entities than the value specifies.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of entities to return. The service may return
fewer entities than the value specifies.
Parameter
Name
Description
var
int
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTree
Required. The tree to fetch.
Returns
Type
Description
int
setTree
Required. The tree to fetch.
Parameter
Name
Description
var
int
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getCommitId
Optional. Request a specific commit ID. If not specified, the entities from
the latest commit are returned.
Returns
Type
Description
string
setCommitId
Optional. Request a specific commit ID. If not specified, the entities from
the latest commit are returned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. Filter the returned entities based on AIP-160 standard.
Returns
Type
Description
string
setFilter
Optional. Filter the returned entities based on AIP-160 standard.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dms V1 Client - Class DescribeDatabaseEntitiesRequest (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-dms/latest/V1.DescribeDatabaseEntitiesRequest)\n- [2.0.5](/php/docs/reference/cloud-dms/2.0.5/V1.DescribeDatabaseEntitiesRequest)\n- [1.5.5](/php/docs/reference/cloud-dms/1.5.5/V1.DescribeDatabaseEntitiesRequest)\n- [1.4.2](/php/docs/reference/cloud-dms/1.4.2/V1.DescribeDatabaseEntitiesRequest)\n- [1.3.0](/php/docs/reference/cloud-dms/1.3.0/V1.DescribeDatabaseEntitiesRequest)\n- [1.2.1](/php/docs/reference/cloud-dms/1.2.1/V1.DescribeDatabaseEntitiesRequest)\n- [1.1.0](/php/docs/reference/cloud-dms/1.1.0/V1.DescribeDatabaseEntitiesRequest)\n- [1.0.5](/php/docs/reference/cloud-dms/1.0.5/V1.DescribeDatabaseEntitiesRequest) \nReference documentation and code samples for the Google Cloud Dms V1 Client class DescribeDatabaseEntitiesRequest.\n\nRequest message for 'DescribeDatabaseEntities' request.\n\nGenerated from protobuf message `google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ CloudDms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getConversionWorkspace\n\nRequired. Name of the conversion workspace resource whose database entities\nare described. Must be in the form of:\nprojects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.\n\n### setConversionWorkspace\n\nRequired. Name of the conversion workspace resource whose database entities\nare described. Must be in the form of:\nprojects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.\n\n### getPageSize\n\nOptional. The maximum number of entities to return. The service may return\nfewer entities than the value specifies.\n\n### setPageSize\n\nOptional. The maximum number of entities to return. The service may return\nfewer entities than the value specifies.\n\n### getPageToken\n\nOptional. The nextPageToken value received in the previous call to\nconversionWorkspace.describeDatabaseEntities, used in the subsequent\nrequest to retrieve the next page of results. On first call this should be\nleft blank. When paginating, all other parameters provided to\nconversionWorkspace.describeDatabaseEntities must match the call that\nprovided the page token.\n\n### setPageToken\n\nOptional. The nextPageToken value received in the previous call to\nconversionWorkspace.describeDatabaseEntities, used in the subsequent\nrequest to retrieve the next page of results. On first call this should be\nleft blank. When paginating, all other parameters provided to\nconversionWorkspace.describeDatabaseEntities must match the call that\nprovided the page token.\n\n### getTree\n\nRequired. The tree to fetch.\n\n### setTree\n\nRequired. The tree to fetch.\n\n### getUncommitted\n\nOptional. Whether to retrieve the latest committed version of the entities\nor the latest version. This field is ignored if a specific commit_id is\nspecified.\n\n### setUncommitted\n\nOptional. Whether to retrieve the latest committed version of the entities\nor the latest version. This field is ignored if a specific commit_id is\nspecified.\n\n### getCommitId\n\nOptional. Request a specific commit ID. If not specified, the entities from\nthe latest commit are returned.\n\n### setCommitId\n\nOptional. Request a specific commit ID. If not specified, the entities from\nthe latest commit are returned.\n\n### getFilter\n\nOptional. Filter the returned entities based on AIP-160 standard.\n\n### setFilter\n\nOptional. Filter the returned entities based on AIP-160 standard.\n\n### getView\n\nOptional. Results view based on AIP-157\n\n### setView\n\nOptional. Results view based on AIP-157"]]
