Class GameServerClustersServiceClient (2.11.0)

The game server cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

GameServerClustersServiceClient(GameServerClustersServiceClient const &)

Copy and move support

Parameter
Name Description
GameServerClustersServiceClient const &

GameServerClustersServiceClient(GameServerClustersServiceClient &&)

Copy and move support

Parameter
Name Description
GameServerClustersServiceClient &&

GameServerClustersServiceClient(std::shared_ptr< GameServerClustersServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< GameServerClustersServiceConnection >
opts Options

Operators

operator=(GameServerClustersServiceClient const &)

Copy and move support

Parameter
Name Description
GameServerClustersServiceClient const &
Returns
Type Description
GameServerClustersServiceClient &

operator=(GameServerClustersServiceClient &&)

Copy and move support

Parameter
Name Description
GameServerClustersServiceClient &&
Returns
Type Description
GameServerClustersServiceClient &

Functions

ListGameServerClusters(std::string const &, Options)

Lists game server clusters in a given project and location.

Parameters
Name Description
parent std::string const &

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

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::gaming::v1::GameServerCluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gaming.v1.GameServerCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListGameServerClusters(google::cloud::gaming::v1::ListGameServerClustersRequest, Options)

Lists game server clusters in a given project and location.

Parameters
Name Description
request google::cloud::gaming::v1::ListGameServerClustersRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gaming.v1.ListGameServerClustersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::gaming::v1::GameServerCluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gaming.v1.GameServerCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetGameServerCluster(std::string const &, Options)

Gets details of a single game server cluster.

Parameters
Name Description
name std::string const &

Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::gaming::v1::GameServerCluster >

the result of the RPC. The response message type (google.cloud.gaming.v1.GameServerCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetGameServerCluster(google::cloud::gaming::v1::GetGameServerClusterRequest const &, Options)

Gets details of a single game server cluster.

Parameters
Name Description
request google::cloud::gaming::v1::GetGameServerClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gaming.v1.GetGameServerClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::gaming::v1::GameServerCluster >

the result of the RPC. The response message type (google.cloud.gaming.v1.GameServerCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateGameServerCluster(std::string const &, google::cloud::gaming::v1::GameServerCluster const &, std::string const &, Options)

Creates a new game server cluster in a given project and location.

Parameters
Name Description
parent std::string const &

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

game_server_cluster google::cloud::gaming::v1::GameServerCluster const &

Required. The game server cluster resource to be created.

game_server_cluster_id std::string const &

Required. The ID of the game server cluster resource to be created.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::gaming::v1::GameServerCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gaming.v1.GameServerCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateGameServerCluster(google::cloud::gaming::v1::CreateGameServerClusterRequest const &, Options)

Creates a new game server cluster in a given project and location.

Parameters
Name Description
request google::cloud::gaming::v1::CreateGameServerClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gaming.v1.CreateGameServerClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::gaming::v1::GameServerCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gaming.v1.GameServerCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PreviewCreateGameServerCluster(google::cloud::gaming::v1::PreviewCreateGameServerClusterRequest const &, Options)

Previews creation of a new game server cluster in a given project and location.

Parameters
Name Description
request google::cloud::gaming::v1::PreviewCreateGameServerClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gaming.v1.PreviewCreateGameServerClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::gaming::v1::PreviewCreateGameServerClusterResponse >

the result of the RPC. The response message type (google.cloud.gaming.v1.PreviewCreateGameServerClusterResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteGameServerCluster(std::string const &, Options)

Deletes a single game server cluster.

Parameters
Name Description
name std::string const &

Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::gaming::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gaming.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteGameServerCluster(google::cloud::gaming::v1::DeleteGameServerClusterRequest const &, Options)

Deletes a single game server cluster.

Parameters
Name Description
request google::cloud::gaming::v1::DeleteGameServerClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gaming.v1.DeleteGameServerClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::gaming::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gaming.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PreviewDeleteGameServerCluster(google::cloud::gaming::v1::PreviewDeleteGameServerClusterRequest const &, Options)

Previews deletion of a single game server cluster.

Parameters
Name Description
request google::cloud::gaming::v1::PreviewDeleteGameServerClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gaming.v1.PreviewDeleteGameServerClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::gaming::v1::PreviewDeleteGameServerClusterResponse >

the result of the RPC. The response message type (google.cloud.gaming.v1.PreviewDeleteGameServerClusterResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateGameServerCluster(google::cloud::gaming::v1::GameServerCluster const &, google::protobuf::FieldMask const &, Options)

Patches a single game server cluster.

Parameters
Name Description
game_server_cluster google::cloud::gaming::v1::GameServerCluster const &

Required. The game server cluster to be updated. Only fields specified in update_mask are updated.

update_mask google::protobuf::FieldMask const &

Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::gaming::v1::GameServerCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gaming.v1.GameServerCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateGameServerCluster(google::cloud::gaming::v1::UpdateGameServerClusterRequest const &, Options)

Patches a single game server cluster.

Parameters
Name Description
request google::cloud::gaming::v1::UpdateGameServerClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gaming.v1.UpdateGameServerClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::gaming::v1::GameServerCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gaming.v1.GameServerCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PreviewUpdateGameServerCluster(google::cloud::gaming::v1::PreviewUpdateGameServerClusterRequest const &, Options)

Previews updating a GameServerCluster.

Parameters
Name Description
request google::cloud::gaming::v1::PreviewUpdateGameServerClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gaming.v1.PreviewUpdateGameServerClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::gaming::v1::PreviewUpdateGameServerClusterResponse >

the result of the RPC. The response message type (google.cloud.gaming.v1.PreviewUpdateGameServerClusterResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.