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 messagegoogle.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 seeDataMigrationServiceClient::conversionWorkspaceName()for help formatting this field.
[[["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 ListMappingRulesRequest (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-dms/latest/V1.ListMappingRulesRequest)\n- [2.0.5](/php/docs/reference/cloud-dms/2.0.5/V1.ListMappingRulesRequest)\n- [1.5.5](/php/docs/reference/cloud-dms/1.5.5/V1.ListMappingRulesRequest)\n- [1.4.2](/php/docs/reference/cloud-dms/1.4.2/V1.ListMappingRulesRequest)\n- [1.3.0](/php/docs/reference/cloud-dms/1.3.0/V1.ListMappingRulesRequest)\n- [1.2.1](/php/docs/reference/cloud-dms/1.2.1/V1.ListMappingRulesRequest)\n- [1.1.0](/php/docs/reference/cloud-dms/1.1.0/V1.ListMappingRulesRequest)\n- [1.0.5](/php/docs/reference/cloud-dms/1.0.5/V1.ListMappingRulesRequest) \nReference documentation and code samples for the Google Cloud Dms V1 Client class ListMappingRulesRequest.\n\nRetrieve a list of all mapping rules in a given conversion workspace.\n\nGenerated from protobuf message `google.cloud.clouddms.v1.ListMappingRulesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ CloudDms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Name of the conversion workspace resource whose mapping rules are\nlisted in the form of:\nprojects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.\n\n### setParent\n\nRequired. Name of the conversion workspace resource whose mapping rules are\nlisted in the form of:\nprojects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.\n\n### getPageSize\n\nThe maximum number of rules to return. The service may return\nfewer than this value.\n\n### setPageSize\n\nThe maximum number of rules to return. The service may return\nfewer than this value.\n\n### getPageToken\n\nThe nextPageToken value received in the previous call to\nmappingRules.list, used in the subsequent request to retrieve the next\npage of results. On first call this should be left blank. When paginating,\nall other parameters provided to mappingRules.list must match the call\nthat provided the page token.\n\n### setPageToken\n\nThe nextPageToken value received in the previous call to\nmappingRules.list, used in the subsequent request to retrieve the next\npage of results. On first call this should be left blank. When paginating,\nall other parameters provided to mappingRules.list must match the call\nthat provided the page token.\n\n### static::build"]]
