Google Cloud Config V1 Client - Class ListResourcesRequest (0.2.0)

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

A request to list Resources passed to a 'ListResources' call.

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

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 Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.
`↳ 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 'ListResources' which specifies the position in the list from where to continue listing the resources.
`↳ filter`	`string` Lists the Resources 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/dep/revisions/bar/resources/baz
`↳ order_by`	`string` Field to use to sort the list.

getParent

Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

Returns
Type	Description
`string`

setParent

Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

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

Returns
Type	Description
`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
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Token returned by previous call to 'ListResources' 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 'ListResources' 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 Resources 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/dep/revisions/bar/resources/baz

Returns
Type	Description
`string`

setFilter

Examples:

Filter by name: name = "projects/foo/locations/us-central1/deployments/dep/revisions/bar/resources/baz

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 Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'. Please see Google\Cloud\Config\V1\ConfigClient::revisionName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Config\V1\ListResourcesRequest`