Cloud Gaming V1 API - Class Google::Cloud::Gaming::V1::ListGameServerClustersRequest (v0.4.4)

Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Cloud Gaming V1 API class Google::Cloud::Gaming::V1::ListGameServerClustersRequest.

Request message for GameServerClustersService.ListGameServerClusters.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. The filter to apply to list results.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. The filter to apply to list results.
Returns
  • (::String) — Optional. The filter to apply to list results.

#order_by

def order_by() -> ::String
Returns
  • (::String) — Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
Returns
  • (::String) — Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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

def page_token() -> ::String
Returns
  • (::String) — Optional. The next_page_token value returned from a previous List request, if any.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. The next_page_token value returned from a previous List request, if any.
Returns
  • (::String) — Optional. The next_page_token value returned from a previous List request, if any.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".
Returns
  • (::String) — Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".

#view

def view() -> ::Google::Cloud::Gaming::V1::GameServerClusterView
Returns
  • (::Google::Cloud::Gaming::V1::GameServerClusterView) — 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.

#view=

def view=(value) -> ::Google::Cloud::Gaming::V1::GameServerClusterView
Parameter
  • value (::Google::Cloud::Gaming::V1::GameServerClusterView) — 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
  • (::Google::Cloud::Gaming::V1::GameServerClusterView) — 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.