Google Cloud Datastream V1 Client - Class ListConnectionProfilesRequest (1.5.4)

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

Request message for listing connection profiles.

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

Namespace

Google \ Cloud \ Datastream \ 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 connection profiles.

↳ page_size int

Maximum number of connection profiles to return. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

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

Filter request.

↳ order_by string

Order by fields for the result.

getParent

Required. The parent that owns the collection of connection profiles.

Returns
Type Description
string

setParent

Required. The parent that owns the collection of connection profiles.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Maximum number of connection profiles to return.

If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

Maximum number of connection profiles to return.

If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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
Type Description
string

setPageToken

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
Name Description
var string
Returns
Type Description
$this

getFilter

Filter request.

Returns
Type Description
string

setFilter

Filter request.

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 connection profiles. Please see Google\Cloud\Datastream\V1\DatastreamClient::locationName() for help formatting this field.

Returns
Type Description
Google\Cloud\Datastream\V1\ListConnectionProfilesRequest