Google Cloud Game Servers V1 Client - Class ListGameServerClustersRequest (1.1.1)

Reference documentation and code samples for the Google Cloud Game Servers V1 Client class ListGameServerClustersRequest.

Request message for GameServerClustersService.ListGameServerClusters.

Generated from protobuf message google.cloud.gaming.v1.ListGameServerClustersRequest

Namespace

Google \ Cloud \ Gaming \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".
`↳ page_size`	`int` Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.
`↳ page_token`	`string` Optional. The next_page_token value returned from a previous List request, if any.
`↳ filter`	`string` Optional. The filter to apply to list results.
`↳ order_by`	`string` Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
`↳ view`	`int` Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the `cluster_state` field.

getParent

Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".

Returns
Type	Description
`string`

setParent

Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.

Returns
Type	Description
`int`

setPageSize

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. The next_page_token value returned from a previous List request, if any.

Returns
Type	Description
`string`

setPageToken

Optional. The next_page_token value returned from a previous List request, if any.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. The filter to apply to list results.

Returns
Type	Description
`string`

setFilter

Optional. The filter to apply to list results.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Returns
Type	Description
`string`

setOrderBy

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getView

Optional. View for the returned GameServerCluster objects. When FULL is specified, the cluster_state field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the cluster_state field.

Returns
Type	Description
`int`

setView

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}". Please see Google\Cloud\Gaming\V1\GameServerClustersServiceClient::realmName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Gaming\V1\ListGameServerClustersRequest`