Game Services v1 API - Class ListGameServerClustersRequest (2.2.0)

public sealed class ListGameServerClustersRequest : IMessage<ListGameServerClustersRequest>, IEquatable<ListGameServerClustersRequest>, IDeepCloneable<ListGameServerClustersRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Game Services v1 API class ListGameServerClustersRequest.

Request message for GameServerClustersService.ListGameServerClusters.

Inheritance

object > ListGameServerClustersRequest

Implements

IMessage ListGameServerClustersRequest, IEquatable ListGameServerClustersRequest, IDeepCloneable ListGameServerClustersRequest, IBufferMessage, IMessage, IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Constructors

ListGameServerClustersRequest()

public ListGameServerClustersRequest()

ListGameServerClustersRequest(ListGameServerClustersRequest)

public ListGameServerClustersRequest(ListGameServerClustersRequest other)

Parameter
Name	Description
`other`	`ListGameServerClustersRequest`

Properties

Filter

public string Filter { get; set; }

Optional. The filter to apply to list results.

Property Value
Type	Description
`string`

OrderBy

public string OrderBy { get; set; }

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

Property Value
Type	Description
`string`

PageSize

public int PageSize { get; set; }

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][google.cloud.gaming.v1.ListGameServerClustersResponse.next_page_token] to determine if there are more GameServerClusters left to be queried.

Property Value
Type	Description
`int`

PageToken

public string PageToken { get; set; }

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

Property Value
Type	Description
`string`

Parent

public string Parent { get; set; }

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

Property Value
Type	Description
`string`

ParentAsRealmName

public RealmName ParentAsRealmName { get; set; }

RealmName-typed view over the Parent resource name property.

Property Value
Type	Description
`RealmName`

View

public GameServerClusterView View { get; set; }

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.

Property Value
Type	Description
`GameServerClusterView`