Reference documentation and code samples for the Google Cloud Dms V1 Client class ListPrivateConnectionsRequest.
Request message to retrieve a list of private connections in a given project
and location.
Generated from protobuf messagegoogle.cloud.clouddms.v1.ListPrivateConnectionsRequest
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 that owns the collection of private connections.
↳ page_size
int
Maximum number of private connections to return. If unspecified, at most 50 private connections that are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
↳ page_token
string
Page token received from a previousListPrivateConnectionscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListPrivateConnectionsmust match the call that provided the page token.
↳ filter
string
A filter expression that filters private connections 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 private connections created this year by specifyingcreateTime %gt; 2021-01-01T00:00:00.000000000Z.
↳ order_by
string
Order by fields for the result.
getParent
Required. The parent that owns the collection of private connections.
Returns
Type
Description
string
setParent
Required. The parent that owns the collection of private connections.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Maximum number of private connections to return.
If unspecified, at most 50 private connections that are returned.
The maximum value is 1000; values above 1000 are coerced to 1000.
Returns
Type
Description
int
setPageSize
Maximum number of private connections to return.
If unspecified, at most 50 private connections that are returned.
The maximum value is 1000; values above 1000 are coerced to 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Page token received from a previousListPrivateConnectionscall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListPrivateConnectionsmust match the call that provided the page
token.
Returns
Type
Description
string
setPageToken
Page token received from a previousListPrivateConnectionscall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListPrivateConnectionsmust match the call that provided the page
token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
A filter expression that filters private connections 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 private connections created this year by
specifyingcreateTime %gt; 2021-01-01T00:00:00.000000000Z.
Returns
Type
Description
string
setFilter
A filter expression that filters private connections 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 private connections created this year by
specifyingcreateTime %gt; 2021-01-01T00:00:00.000000000Z.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Order by fields for the result.
Returns
Type
Description
string
setOrderBy
Order by fields for the result.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent that owns the collection of private connections. 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 ListPrivateConnectionsRequest (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-dms/latest/V1.ListPrivateConnectionsRequest)\n- [2.0.5](/php/docs/reference/cloud-dms/2.0.5/V1.ListPrivateConnectionsRequest)\n- [1.5.5](/php/docs/reference/cloud-dms/1.5.5/V1.ListPrivateConnectionsRequest)\n- [1.4.2](/php/docs/reference/cloud-dms/1.4.2/V1.ListPrivateConnectionsRequest)\n- [1.3.0](/php/docs/reference/cloud-dms/1.3.0/V1.ListPrivateConnectionsRequest)\n- [1.2.1](/php/docs/reference/cloud-dms/1.2.1/V1.ListPrivateConnectionsRequest)\n- [1.1.0](/php/docs/reference/cloud-dms/1.1.0/V1.ListPrivateConnectionsRequest)\n- [1.0.5](/php/docs/reference/cloud-dms/1.0.5/V1.ListPrivateConnectionsRequest) \nReference documentation and code samples for the Google Cloud Dms V1 Client class ListPrivateConnectionsRequest.\n\nRequest message to retrieve a list of private connections in a given project\nand location.\n\nGenerated from protobuf message `google.cloud.clouddms.v1.ListPrivateConnectionsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ CloudDms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent that owns the collection of private connections.\n\n### setParent\n\nRequired. The parent that owns the collection of private connections.\n\n### getPageSize\n\nMaximum number of private connections to return.\n\nIf unspecified, at most 50 private connections that are returned.\nThe maximum value is 1000; values above 1000 are coerced to 1000.\n\n### setPageSize\n\nMaximum number of private connections to return.\n\nIf unspecified, at most 50 private connections that are returned.\nThe maximum value is 1000; values above 1000 are coerced to 1000.\n\n### getPageToken\n\nPage token received from a previous `ListPrivateConnections` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to\n`ListPrivateConnections` must match the call that provided the page\ntoken.\n\n### setPageToken\n\nPage token received from a previous `ListPrivateConnections` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to\n`ListPrivateConnections` must match the call that provided the page\ntoken.\n\n### getFilter\n\nA filter expression that filters private connections 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 private connections created this year by\nspecifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.\n\n### setFilter\n\nA filter expression that filters private connections 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 private connections created this year by\nspecifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.\n\n### getOrderBy\n\nOrder by fields for the result.\n\n### setOrderBy\n\nOrder by fields for the result.\n\n### static::build"]]
