Google Cloud Ces V1 Client - Class ListDeploymentsRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class ListDeploymentsRequest.

Request message for AgentService.ListDeployments.

Generated from protobuf message google.cloud.ces.v1.ListDeploymentsRequest

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent app. Format: projects/{project}/locations/{location}/apps/{app}
↳ page_size	int Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
↳ page_token	string Optional. A page token, received from a previous ListDeployments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDeployments must match the call that provided the page token.
↳ order_by	string Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.

getParent

Required. The parent app.

Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type	Description
string

setParent

Required. The parent app.

Format: projects/{project}/locations/{location}/apps/{app}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments 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

Optional. A page token, received from a previous ListDeployments call.

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

Returns
Type	Description
string

setPageToken

Optional. A page token, received from a previous ListDeployments call.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

Optional. Field to sort by. Only "name" and "create_time" is supported.

See https://google.aip.dev/132#ordering for more details.

Returns
Type	Description
string

setOrderBy

Optional. Field to sort by. Only "name" and "create_time" is supported.

See https://google.aip.dev/132#ordering for more details.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The parent app. Format: projects/{project}/locations/{location}/apps/{app} Please see AgentServiceClient::appName() for help formatting this field.

Returns
Type	Description
ListDeploymentsRequest