Google Cloud Dms V1 Client - Class DescribeDatabaseEntitiesRequest (1.1.0)

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
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of entities to return. The service may return fewer entities than the value specifies.

Returns
TypeDescription
int

setPageSize

The maximum number of entities to return. The service may return fewer entities than the value specifies.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getTree

The tree to fetch.

Returns
TypeDescription
int

setTree

The tree to fetch.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

getCommitId

Request a specific commit ID. If not specified, the entities from the latest commit are returned.

Returns
TypeDescription
string

setCommitId

Request a specific commit ID. If not specified, the entities from the latest commit are returned.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Filter the returned entities based on AIP-160 standard.

Returns
TypeDescription
string

setFilter

Filter the returned entities based on AIP-160 standard.

Parameter
NameDescription
var string
Returns
TypeDescription
$this