Google Cloud Gke Hub V1 Client - Class ListBoundMembershipsRequest (1.3.0)

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

Request to list Memberships bound to a Scope.

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

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ scope_name string

Required. Name of the Scope, in the format projects/*/locations/global/scopes/*, to which the Memberships are bound.
↳ filter string

Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's name, labels, create_time, update_time, and unique_id.
↳ 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. Pagination is currently not supported; therefore, setting this field does not have any impact for now.
↳ page_token string

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

getScopeName

Required. Name of the Scope, in the format projects/*/locations/global/scopes/*, to which the Memberships are bound.

Returns
Type Description
string

setScopeName

Required. Name of the Scope, in the format projects/*/locations/global/scopes/*, to which the Memberships are bound.

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. Currently, filtering can be done only based on Memberships's name, labels, create_time, update_time, and unique_id.

Returns
Type Description
string

setFilter

Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Currently, filtering can be done only based on Memberships's name, labels, create_time, update_time, and unique_id.

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. Pagination is currently not supported; therefore, setting this field does not have any impact for now.

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. Pagination is currently not supported; therefore, setting this field does not have any impact for now.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. Token returned by previous call to ListBoundMemberships 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 ListBoundMemberships which specifies the position in the list from where to continue listing the resources.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
scopeName string

Required. Name of the Scope, in the format projects/*/locations/global/scopes/*, to which the Memberships are bound. Please see GkeHubClient::scopeName() for help formatting this field.
Returns
Type Description
ListBoundMembershipsRequest