Google Cloud Dms V1 Client - Class ListConnectionProfilesRequest (1.4.2)

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

Request message for 'ListConnectionProfiles' request.

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

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 previous ListConnectionProfiles call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConnectionProfiles must 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 specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify mySql.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
TypeDescription
string

setParent

Required. The parent which owns this collection of connection profiles.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A page token, received from a previous ListConnectionProfiles call.

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

Returns
TypeDescription
string

setPageToken

A page token, received from a previous ListConnectionProfiles call.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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 specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify mySql.username = %lt;my_username%gt; to list all connection profiles configured to connect with a specific username.

Returns
TypeDescription
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 specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify mySql.username = %lt;my_username%gt; to list all connection profiles configured to connect with a specific username.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

A comma-separated list of fields to order results according to.

Returns
TypeDescription
string

setOrderBy

A comma-separated list of fields to order results according to.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The parent which owns this collection of connection profiles. Please see Google\Cloud\CloudDms\V1\DataMigrationServiceClient::locationName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\ListConnectionProfilesRequest