Google Cloud Deploy V1 Client - Class ListAutomationsRequest (1.2.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class ListAutomationsRequest.

The request object for ListAutomations.

Generated from protobuf message google.cloud.deploy.v1.ListAutomationsRequest

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

↳ page_size int

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

↳ page_token string

A page token, received from a previous ListAutomations call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.

↳ filter string

Filter automations to be returned. All fields can be used in the filter.

↳ order_by string

Field to sort by.

getParent

Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Returns
Type Description
string

setParent

Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

Returns
Type Description
int

setPageSize

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

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous ListAutomations call.

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

Returns
Type Description
string

setPageToken

A page token, received from a previous ListAutomations call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Filter automations to be returned. All fields can be used in the filter.

Returns
Type Description
string

setFilter

Filter automations to be returned. All fields can be used in the filter.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Field to sort by.

Returns
Type Description
string

setOrderBy

Field to sort by.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. Please see Google\Cloud\Deploy\V1\CloudDeployClient::deliveryPipelineName() for help formatting this field.

Returns
Type Description
Google\Cloud\Deploy\V1\ListAutomationsRequest