Reference documentation and code samples for the Google Cloud Telco Automation V1 Client class ListDeploymentsRequest.
Request object forListDeployments.
Generated from protobuf messagegoogle.cloud.telcoautomation.v1.ListDeploymentsRequest
Namespace
Google \ Cloud \ TelcoAutomation \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
↳ filter
string
Optional. Filtering only supports equality on deployment state. It should be in the form: "state = DRAFT".ORoperator can be used to get response for multiple states. e.g. "state = DRAFT OR state = APPLIED".
↳ page_size
int
Optional. The maximum number of deployments to return per page.
↳ page_token
string
Optional. The page token, received from a previous ListDeployments call. It can be provided to retrieve the subsequent page.
getParent
Required. The name of parent orchestration cluster resource.
Format should be -
"projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
Returns
Type
Description
string
setParent
Required. The name of parent orchestration cluster resource.
Format should be -
"projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}".
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. Filtering only supports equality on deployment state.
It should be in the form: "state = DRAFT".ORoperator can be used to
get response for multiple states. e.g. "state = DRAFT OR state = APPLIED".
Returns
Type
Description
string
setFilter
Optional. Filtering only supports equality on deployment state.
It should be in the form: "state = DRAFT".ORoperator can be used to
get response for multiple states. e.g. "state = DRAFT OR state = APPLIED".
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of deployments to return per page.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of deployments to return per page.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. The page token, received from a previous ListDeployments call.
It can be provided to retrieve the subsequent page.
Returns
Type
Description
string
setPageToken
Optional. The page token, received from a previous ListDeployments call.
It can be provided to retrieve the subsequent page.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The name of parent orchestration cluster resource.
Format should be -
"projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". Please seeTelcoAutomationClient::orchestrationClusterName()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 Telco Automation V1 Client - Class ListDeploymentsRequest (1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/php/docs/reference/cloud-telcoautomation/latest/V1.ListDeploymentsRequest)\n- [1.1.0](/php/docs/reference/cloud-telcoautomation/1.1.0/V1.ListDeploymentsRequest)\n- [1.0.3](/php/docs/reference/cloud-telcoautomation/1.0.3/V1.ListDeploymentsRequest)\n- [0.2.5](/php/docs/reference/cloud-telcoautomation/0.2.5/V1.ListDeploymentsRequest)\n- [0.1.0](/php/docs/reference/cloud-telcoautomation/0.1.0/V1.ListDeploymentsRequest) \nReference documentation and code samples for the Google Cloud Telco Automation V1 Client class ListDeploymentsRequest.\n\nRequest object for `ListDeployments`.\n\nGenerated from protobuf message `google.cloud.telcoautomation.v1.ListDeploymentsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ TelcoAutomation \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The name of parent orchestration cluster resource.\n\nFormat should be -\n\"projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}\".\n\n### setParent\n\nRequired. The name of parent orchestration cluster resource.\n\nFormat should be -\n\"projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}\".\n\n### getFilter\n\nOptional. Filtering only supports equality on deployment state.\n\nIt should be in the form: \"state = DRAFT\". `OR` operator can be used to\nget response for multiple states. e.g. \"state = DRAFT OR state = APPLIED\".\n\n### setFilter\n\nOptional. Filtering only supports equality on deployment state.\n\nIt should be in the form: \"state = DRAFT\". `OR` operator can be used to\nget response for multiple states. e.g. \"state = DRAFT OR state = APPLIED\".\n\n### getPageSize\n\nOptional. The maximum number of deployments to return per page.\n\n### setPageSize\n\nOptional. The maximum number of deployments to return per page.\n\n### getPageToken\n\nOptional. The page token, received from a previous ListDeployments call.\n\nIt can be provided to retrieve the subsequent page.\n\n### setPageToken\n\nOptional. The page token, received from a previous ListDeployments call.\n\nIt can be provided to retrieve the subsequent page.\n\n### static::build"]]
