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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Deploy V1 Client - Class ListAutomationsRequest (2.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0 (latest)](/php/docs/reference/cloud-deploy/latest/V1.ListAutomationsRequest)\n- [1.5.7](/php/docs/reference/cloud-deploy/1.5.7/V1.ListAutomationsRequest)\n- [1.4.0](/php/docs/reference/cloud-deploy/1.4.0/V1.ListAutomationsRequest)\n- [1.3.0](/php/docs/reference/cloud-deploy/1.3.0/V1.ListAutomationsRequest)\n- [1.2.0](/php/docs/reference/cloud-deploy/1.2.0/V1.ListAutomationsRequest)\n- [1.1.1](/php/docs/reference/cloud-deploy/1.1.1/V1.ListAutomationsRequest)\n- [1.0.0](/php/docs/reference/cloud-deploy/1.0.0/V1.ListAutomationsRequest)\n- [0.19.1](/php/docs/reference/cloud-deploy/0.19.1/V1.ListAutomationsRequest)\n- [0.18.1](/php/docs/reference/cloud-deploy/0.18.1/V1.ListAutomationsRequest)\n- [0.17.0](/php/docs/reference/cloud-deploy/0.17.0/V1.ListAutomationsRequest)\n- [0.16.0](/php/docs/reference/cloud-deploy/0.16.0/V1.ListAutomationsRequest)\n- [0.15.0](/php/docs/reference/cloud-deploy/0.15.0/V1.ListAutomationsRequest)\n- [0.14.0](/php/docs/reference/cloud-deploy/0.14.0/V1.ListAutomationsRequest)\n- [0.13.1](/php/docs/reference/cloud-deploy/0.13.1/V1.ListAutomationsRequest)\n- [0.12.1](/php/docs/reference/cloud-deploy/0.12.1/V1.ListAutomationsRequest)\n- [0.11.1](/php/docs/reference/cloud-deploy/0.11.1/V1.ListAutomationsRequest)\n- [0.10.0](/php/docs/reference/cloud-deploy/0.10.0/V1.ListAutomationsRequest)\n- [0.9.0](/php/docs/reference/cloud-deploy/0.9.0/V1.ListAutomationsRequest)\n- [0.8.0](/php/docs/reference/cloud-deploy/0.8.0/V1.ListAutomationsRequest)\n- [0.7.0](/php/docs/reference/cloud-deploy/0.7.0/V1.ListAutomationsRequest)\n- [0.6.0](/php/docs/reference/cloud-deploy/0.6.0/V1.ListAutomationsRequest)\n- [0.5.0](/php/docs/reference/cloud-deploy/0.5.0/V1.ListAutomationsRequest)\n- [0.4.1](/php/docs/reference/cloud-deploy/0.4.1/V1.ListAutomationsRequest)\n- [0.3.4](/php/docs/reference/cloud-deploy/0.3.4/V1.ListAutomationsRequest) \nReference documentation and code samples for the Google Cloud Deploy V1 Client class ListAutomationsRequest.\n\nThe request object for `ListAutomations`.\n\nGenerated from protobuf message `google.cloud.deploy.v1.ListAutomationsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Deploy \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent `Delivery Pipeline`, which owns this collection of\nautomations. Format must be\n`projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.\n\n### setParent\n\nRequired. The parent `Delivery Pipeline`, which owns this collection of\nautomations. Format must be\n`projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.\n\n### getPageSize\n\nThe maximum number of automations to return. The service may return\nfewer than this value. If unspecified, at most 50 automations will\nbe returned. The maximum value is 1000; values above 1000 will be set\nto 1000.\n\n### setPageSize\n\nThe maximum number of automations to return. The service may return\nfewer than this value. If unspecified, at most 50 automations will\nbe returned. The maximum value is 1000; values above 1000 will be set\nto 1000.\n\n### getPageToken\n\nA page token, received from a previous `ListAutomations` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other provided parameters match\nthe call that provided the page token.\n\n### setPageToken\n\nA page token, received from a previous `ListAutomations` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other provided parameters match\nthe call that provided the page token.\n\n### getFilter\n\nFilter automations to be returned. All fields can be used in the\nfilter.\n\n### setFilter\n\nFilter automations to be returned. All fields can be used in the\nfilter.\n\n### getOrderBy\n\nField to sort by.\n\n### setOrderBy\n\nField to sort by.\n\n### static::build"]]