Google Cloud Dms V1 Client - Class ListMappingRulesRequest (1.5.5)

Reference documentation and code samples for the Google Cloud Dms V1 Client class ListMappingRulesRequest.

Retrieve a list of all mapping rules in a given conversion workspace.

Generated from protobuf message google.cloud.clouddms.v1.ListMappingRulesRequest

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Name of the conversion workspace resource whose mapping rules are listed in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

↳ page_size int

The maximum number of rules to return. The service may return fewer than this value.

↳ page_token string

The nextPageToken value received in the previous call to mappingRules.list, 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 mappingRules.list must match the call that provided the page token.

getParent

Required. Name of the conversion workspace resource whose mapping rules are listed in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Returns
Type Description
string

setParent

Required. Name of the conversion workspace resource whose mapping rules are listed 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 rules to return. The service may return fewer than this value.

Returns
Type Description
int

setPageSize

The maximum number of rules to return. The service may return fewer than this value.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The nextPageToken value received in the previous call to mappingRules.list, 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 mappingRules.list must match the call that provided the page token.

Returns
Type Description
string

setPageToken

The nextPageToken value received in the previous call to mappingRules.list, 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 mappingRules.list must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Name of the conversion workspace resource whose mapping rules are listed in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. Please see Google\Cloud\CloudDms\V1\DataMigrationServiceClient::conversionWorkspaceName() for help formatting this field.

Returns
Type Description
Google\Cloud\CloudDms\V1\ListMappingRulesRequest