Reference documentation and code samples for the Google Cloud Telco Automation V1 Client class ListDeploymentsRequest.
Request object for ListDeployments.
Generated from protobuf message google.cloud.telcoautomation.v1.ListDeploymentsRequest
Namespace
Google \ Cloud \ TelcoAutomation \ V1Methods
__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". |
↳ 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". OR operator 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". OR operator 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 see Google\Cloud\TelcoAutomation\V1\TelcoAutomationClient::orchestrationClusterName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\TelcoAutomation\V1\ListDeploymentsRequest | |