Reference documentation and code samples for the Google Cloud Config V1 Client class ListDeploymentsRequest.
Generated from protobuf messagegoogle.cloud.config.v1.ListDeploymentsRequest
Namespace
Google \ Cloud \ Config \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
↳ page_size
int
When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
↳ page_token
string
Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.
↳ filter
string
Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/deployments/bar - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - Deployments in CREATING state. state=CREATING
↳ order_by
string
Field to use to sort the list.
getParent
Required. The parent in whose context the Deployments are listed. The
parent value is in the format:
'projects/{project_id}/locations/{location}'.
Returns
Type
Description
string
setParent
Required. The parent in whose context the Deployments are listed. The
parent value is in the format:
'projects/{project_id}/locations/{location}'.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
When requesting a page of resources, 'page_size' specifies number of
resources to return. If unspecified, at most 500 will be returned. The
maximum value is 1000.
Returns
Type
Description
int
setPageSize
When requesting a page of resources, 'page_size' specifies number of
resources to return. If unspecified, at most 500 will be returned. The
maximum value is 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Token returned by previous call to 'ListDeployments' which specifies the
position in the list from where to continue listing the resources.
Returns
Type
Description
string
setPageToken
Token returned by previous call to 'ListDeployments' which specifies the
position in the list from where to continue listing the resources.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Lists the Deployments that match the filter expression. A filter
expression filters the resources listed in the response. The expression
must be of the form '{field} {operator} {value}' where operators: '<', '>',
'<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS
operator which is roughly synonymous with equality). {field} can refer to a
proto or JSON field, or a synthetic field. Field names can be camelCase or
snake_case.
Examples:
Filter by name:
name = "projects/foo/locations/us-central1/deployments/bar
Filter by labels:
Resources that have a key called 'foo'
labels.foo:*
Resources that have a key called 'foo' whose value is 'bar'
labels.foo = bar
Filter by state:
Deployments in CREATING state.
state=CREATING
Returns
Type
Description
string
setFilter
Lists the Deployments that match the filter expression. A filter
expression filters the resources listed in the response. The expression
must be of the form '{field} {operator} {value}' where operators: '<', '>',
'<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS
operator which is roughly synonymous with equality). {field} can refer to a
proto or JSON field, or a synthetic field. Field names can be camelCase or
snake_case.
Examples:
Filter by name:
name = "projects/foo/locations/us-central1/deployments/bar
Filter by labels:
Resources that have a key called 'foo'
labels.foo:*
Resources that have a key called 'foo' whose value is 'bar'
labels.foo = bar
Filter by state:
Deployments in CREATING state.
state=CREATING
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Field to use to sort the list.
Returns
Type
Description
string
setOrderBy
Field to use to sort the list.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent in whose context the Deployments are listed. The
parent value is in the format:
'projects/{project_id}/locations/{location}'. Please seeConfigClient::locationName()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-09-04 UTC."],[],[],null,["# Google Cloud Config V1 Client - Class ListDeploymentsRequest (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-config/latest/V1.ListDeploymentsRequest)\n- [1.4.0](/php/docs/reference/cloud-config/1.4.0/V1.ListDeploymentsRequest)\n- [1.3.0](/php/docs/reference/cloud-config/1.3.0/V1.ListDeploymentsRequest)\n- [1.2.1](/php/docs/reference/cloud-config/1.2.1/V1.ListDeploymentsRequest)\n- [1.1.0](/php/docs/reference/cloud-config/1.1.0/V1.ListDeploymentsRequest)\n- [1.0.1](/php/docs/reference/cloud-config/1.0.1/V1.ListDeploymentsRequest)\n- [0.5.2](/php/docs/reference/cloud-config/0.5.2/V1.ListDeploymentsRequest)\n- [0.2.0](/php/docs/reference/cloud-config/0.2.0/V1.ListDeploymentsRequest)\n- [0.1.3](/php/docs/reference/cloud-config/0.1.3/V1.ListDeploymentsRequest) \nReference documentation and code samples for the Google Cloud Config V1 Client class ListDeploymentsRequest.\n\nGenerated from protobuf message `google.cloud.config.v1.ListDeploymentsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Config \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent in whose context the Deployments are listed. The\nparent value is in the format:\n'projects/{project_id}/locations/{location}'.\n\n### setParent\n\nRequired. The parent in whose context the Deployments are listed. The\nparent value is in the format:\n'projects/{project_id}/locations/{location}'.\n\n### getPageSize\n\nWhen requesting a page of resources, 'page_size' specifies number of\nresources to return. If unspecified, at most 500 will be returned. The\nmaximum value is 1000.\n\n### setPageSize\n\nWhen requesting a page of resources, 'page_size' specifies number of\nresources to return. If unspecified, at most 500 will be returned. The\nmaximum value is 1000.\n\n### getPageToken\n\nToken returned by previous call to 'ListDeployments' which specifies the\nposition in the list from where to continue listing the resources.\n\n### setPageToken\n\nToken returned by previous call to 'ListDeployments' which specifies the\nposition in the list from where to continue listing the resources.\n\n### getFilter\n\nLists the Deployments that match the filter expression. A filter\nexpression filters the resources listed in the response. The expression\nmust be of the form '{field} {operator} {value}' where operators: '\\\u003c', '\\\u003e',\n'\\\u003c=', '\\\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS\noperator which is roughly synonymous with equality). {field} can refer to a\nproto or JSON field, or a synthetic field. Field names can be camelCase or\nsnake_case.\n\nExamples:\n\n- Filter by name: name = \"projects/foo/locations/us-central1/deployments/bar\n- Filter by labels:\n - Resources that have a key called 'foo' labels.foo:\\*\n - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar\n- Filter by state:\n - Deployments in CREATING state. state=CREATING\n\n### setFilter\n\nLists the Deployments that match the filter expression. A filter\nexpression filters the resources listed in the response. The expression\nmust be of the form '{field} {operator} {value}' where operators: '\\\u003c', '\\\u003e',\n'\\\u003c=', '\\\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS\noperator which is roughly synonymous with equality). {field} can refer to a\nproto or JSON field, or a synthetic field. Field names can be camelCase or\nsnake_case.\n\nExamples:\n\n- Filter by name: name = \"projects/foo/locations/us-central1/deployments/bar\n- Filter by labels:\n - Resources that have a key called 'foo' labels.foo:\\*\n - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar\n- Filter by state:\n - Deployments in CREATING state. state=CREATING\n\n### getOrderBy\n\nField to use to sort the list.\n\n### setOrderBy\n\nField to use to sort the list.\n\n### static::build"]]
