Google Cloud Gke Hub V1 Client - Class ListMembershipsRequest (1.0.1)

Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class ListMembershipsRequest.

Request message for GkeHub.ListMemberships method.

Generated from protobuf message google.cloud.gkehub.v1.ListMembershipsRequest

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The parent (project and location) where the Memberships will be listed. Specified in the format `projects//locations/`. `projects/*/locations/-` list memberships in all the regions.
`↳ page_size`	`int` Optional. 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` Optional. Token returned by previous call to `ListMemberships` which specifies the position in the list from where to continue listing the resources.
`↳ filter`	`string` Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Name is `bar` in project `foo-proj` and location `global`: name = "projects/foo-proj/locations/global/membership/bar" - Memberships that have a label called `foo`: labels.foo:* - Memberships that have a label called `foo` whose value is `bar`: labels.foo = bar - Memberships in the CREATING state: state = CREATING
`↳ order_by`	`string` Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

getParent

Required. The parent (project and location) where the Memberships will be listed. Specified in the format projects/*/locations/*.

projects/*/locations/- list memberships in all the regions.

Returns
Type	Description
`string`

setParent

Required. The parent (project and location) where the Memberships will be listed. Specified in the format projects/*/locations/*.

projects/*/locations/- list memberships in all the regions.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. 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

Optional. 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

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

Returns
Type	Description
`string`

setPageToken

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Examples:

Name is bar in project foo-proj and location global: name = "projects/foo-proj/locations/global/membership/bar"
Memberships that have a label called foo: labels.foo:*
Memberships that have a label called foo whose value is bar: labels.foo = bar
Memberships in the CREATING state: state = CREATING

Returns
Type	Description
`string`

setFilter

Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Examples:

Name is bar in project foo-proj and location global: name = "projects/foo-proj/locations/global/membership/bar"
Memberships that have a label called foo: labels.foo:*
Memberships that have a label called foo whose value is bar: labels.foo = bar
Memberships in the CREATING state: state = CREATING

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Optional. One or more fields to compare and use to sort the output.

See https://google.aip.dev/132#ordering.

Returns
Type	Description
`string`

setOrderBy

Optional. One or more fields to compare and use to sort the output.

See https://google.aip.dev/132#ordering.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The parent (project and location) where the Memberships will be listed. Specified in the format `projects//locations/`. `projects/*/locations/-` list memberships in all the regions. Please see GkeHubClient::locationName() for help formatting this field.

Returns
Type	Description
`ListMembershipsRequest`