Google Cloud Config V1 Client - Class ListDeploymentsRequest (0.1.3)

Reference documentation and code samples for the Google Cloud Config V1 Client class ListDeploymentsRequest.

Generated from protobuf message google.cloud.config.v1.ListDeploymentsRequest

Namespace

Google \ Cloud \ Config \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 or set to 0, all resources will be returned.

↳ 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

Returns
TypeDescription
int

setPageSize

When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

Returns
TypeDescription
string

setPageToken

Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Field to use to sort the list.

Returns
TypeDescription
string

setOrderBy

Field to use to sort the list.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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 see Google\Cloud\Config\V1\ConfigClient::locationName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Config\V1\ListDeploymentsRequest