Google Cloud Dms V1 Client - Class ListPrivateConnectionsRequest (1.5.5)

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 message google.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 previous ListPrivateConnections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPrivateConnections must 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 specifying createTime %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 previous ListPrivateConnections call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPrivateConnections must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Page token received from a previous ListPrivateConnections call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPrivateConnections must 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 specifying createTime %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 specifying createTime %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 see Google\Cloud\CloudDms\V1\DataMigrationServiceClient::locationName() for help formatting this field.

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