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
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
The maximum number of entities to return. The service may return fewer entities than the value specifies. |
↳ page_token |
string
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
The tree to fetch. |
↳ uncommitted |
bool
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
Request a specific commit ID. If not specified, the entities from the latest commit are returned. |
↳ filter |
string
Filter the returned entities based on AIP-160 standard. |
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
The maximum number of entities to return. The service may return fewer entities than the value specifies.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
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
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
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
The tree to fetch.
| Returns | |
|---|---|
| Type | Description |
int | |
setTree
The tree to fetch.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUncommitted
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
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
Request a specific commit ID. If not specified, the entities from the latest commit are returned.
| Returns | |
|---|---|
| Type | Description |
string | |
setCommitId
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
Filter the returned entities based on AIP-160 standard.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Filter the returned entities based on AIP-160 standard.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |