Reference documentation and code samples for the Google Cloud Dms V1 Client class ListConnectionProfilesRequest.
Request message for 'ListConnectionProfiles' request.
Generated from protobuf messagegoogle.cloud.clouddms.v1.ListConnectionProfilesRequest
Namespace
Google \ Cloud \ CloudDms \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent which owns this collection of connection profiles.
↳ page_size
int
The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.
↳ page_token
string
A page token, received from a previousListConnectionProfilescall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListConnectionProfilesmust match the call that provided the page token.
↳ filter
string
A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list connection profiles created this year by specifyingcreateTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specifymySql.username = %lt;my_username%gt;to list all connection profiles configured to connect with a specific username.
↳ order_by
string
A comma-separated list of fields to order results according to.
getParent
Required. The parent which owns this collection of connection profiles.
Returns
Type
Description
string
setParent
Required. The parent which owns this collection of connection profiles.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of connection profiles to return. The service may return
fewer than this value. If unspecified, at most 50 connection profiles will
be returned. The maximum value is 1000; values above 1000 are coerced
to 1000.
Returns
Type
Description
int
setPageSize
The maximum number of connection profiles to return. The service may return
fewer than this value. If unspecified, at most 50 connection profiles will
be returned. The maximum value is 1000; values above 1000 are coerced
to 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
A page token, received from a previousListConnectionProfilescall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListConnectionProfilesmust match the call that provided the page token.
Returns
Type
Description
string
setPageToken
A page token, received from a previousListConnectionProfilescall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListConnectionProfilesmust match the call that provided the page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
A filter expression that filters connection profiles listed in the
response. The expression must specify the field name, a comparison
operator, and the value that you want to use for filtering. The value must
be a string, a number, or a boolean. The comparison operator must be either
=, !=, >, or <. For example, list connection profiles created this year by
specifyingcreateTime %gt; 2020-01-01T00:00:00.000000000Z. You can
also filter nested fields. For example, you could specifymySql.username
= %lt;my_username%gt;to list all connection profiles configured to
connect with a specific username.
Returns
Type
Description
string
setFilter
A filter expression that filters connection profiles listed in the
response. The expression must specify the field name, a comparison
operator, and the value that you want to use for filtering. The value must
be a string, a number, or a boolean. The comparison operator must be either
=, !=, >, or <. For example, list connection profiles created this year by
specifyingcreateTime %gt; 2020-01-01T00:00:00.000000000Z. You can
also filter nested fields. For example, you could specifymySql.username
= %lt;my_username%gt;to list all connection profiles configured to
connect with a specific username.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
A comma-separated list of fields to order results according to.
Returns
Type
Description
string
setOrderBy
A comma-separated list of fields to order results according to.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent which owns this collection of connection profiles. Please seeDataMigrationServiceClient::locationName()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 ListConnectionProfilesRequest (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-dms/latest/V1.ListConnectionProfilesRequest)\n- [2.0.5](/php/docs/reference/cloud-dms/2.0.5/V1.ListConnectionProfilesRequest)\n- [1.5.5](/php/docs/reference/cloud-dms/1.5.5/V1.ListConnectionProfilesRequest)\n- [1.4.2](/php/docs/reference/cloud-dms/1.4.2/V1.ListConnectionProfilesRequest)\n- [1.3.0](/php/docs/reference/cloud-dms/1.3.0/V1.ListConnectionProfilesRequest)\n- [1.2.1](/php/docs/reference/cloud-dms/1.2.1/V1.ListConnectionProfilesRequest)\n- [1.1.0](/php/docs/reference/cloud-dms/1.1.0/V1.ListConnectionProfilesRequest)\n- [1.0.5](/php/docs/reference/cloud-dms/1.0.5/V1.ListConnectionProfilesRequest) \nReference documentation and code samples for the Google Cloud Dms V1 Client class ListConnectionProfilesRequest.\n\nRequest message for 'ListConnectionProfiles' request.\n\nGenerated from protobuf message `google.cloud.clouddms.v1.ListConnectionProfilesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ CloudDms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent which owns this collection of connection profiles.\n\n### setParent\n\nRequired. The parent which owns this collection of connection profiles.\n\n### getPageSize\n\nThe maximum number of connection profiles to return. The service may return\nfewer than this value. If unspecified, at most 50 connection profiles will\nbe returned. The maximum value is 1000; values above 1000 are coerced\nto 1000.\n\n### setPageSize\n\nThe maximum number of connection profiles to return. The service may return\nfewer than this value. If unspecified, at most 50 connection profiles will\nbe returned. The maximum value is 1000; values above 1000 are coerced\nto 1000.\n\n### getPageToken\n\nA page token, received from a previous `ListConnectionProfiles` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListConnectionProfiles`\nmust match the call that provided the page token.\n\n### setPageToken\n\nA page token, received from a previous `ListConnectionProfiles` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListConnectionProfiles`\nmust match the call that provided the page token.\n\n### getFilter\n\nA filter expression that filters connection profiles listed in the\nresponse. The expression must specify the field name, a comparison\noperator, and the value that you want to use for filtering. The value must\nbe a string, a number, or a boolean. The comparison operator must be either\n=, !=, \\\u003e, or \\\u003c. For example, list connection profiles created this year by\nspecifying **createTime %gt; 2020-01-01T00:00:00.000000000Z** . You can\nalso filter nested fields. For example, you could specify **mySql.username\n= %lt;my_username%gt;** to list all connection profiles configured to\nconnect with a specific username.\n\n### setFilter\n\nA filter expression that filters connection profiles listed in the\nresponse. The expression must specify the field name, a comparison\noperator, and the value that you want to use for filtering. The value must\nbe a string, a number, or a boolean. The comparison operator must be either\n=, !=, \\\u003e, or \\\u003c. For example, list connection profiles created this year by\nspecifying **createTime %gt; 2020-01-01T00:00:00.000000000Z** . You can\nalso filter nested fields. For example, you could specify **mySql.username\n= %lt;my_username%gt;** to list all connection profiles configured to\nconnect with a specific username.\n\n### getOrderBy\n\nA comma-separated list of fields to order results according to.\n\n### setOrderBy\n\nA comma-separated list of fields to order results according to.\n\n### static::build"]]
