Class GameServerDeploymentsServiceClient (2.11.0)

The game server deployment is used to control the deployment of Agones fleets.

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

GameServerDeploymentsServiceClient(GameServerDeploymentsServiceClient const &)

Copy and move support

Parameter
Name Description
GameServerDeploymentsServiceClient const &

GameServerDeploymentsServiceClient(GameServerDeploymentsServiceClient &&)

Copy and move support

Parameter
Name Description
GameServerDeploymentsServiceClient &&

GameServerDeploymentsServiceClient(std::shared_ptr< GameServerDeploymentsServiceConnection >, Options)

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

Operators

operator=(GameServerDeploymentsServiceClient const &)

Copy and move support

Parameter
Name Description
GameServerDeploymentsServiceClient const &
Returns
Type Description
GameServerDeploymentsServiceClient &

operator=(GameServerDeploymentsServiceClient &&)

Copy and move support

Parameter
Name Description
GameServerDeploymentsServiceClient &&
Returns
Type Description
GameServerDeploymentsServiceClient &

Functions

ListGameServerDeployments(std::string const &, Options)

Lists game server deployments 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}.

opts Options

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

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

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.GameServerDeployment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListGameServerDeployments(google::cloud::gaming::v1::ListGameServerDeploymentsRequest, Options)

Lists game server deployments in a given project and location.

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

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.ListGameServerDeploymentsRequest. 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::GameServerDeployment >

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.GameServerDeployment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetGameServerDeployment(std::string const &, Options)

Gets details of a single game server deployment.

Parameters
Name Description
name std::string const &

Required. The name of the game server delpoyment to retrieve, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

opts Options

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

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

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

GetGameServerDeployment(google::cloud::gaming::v1::GetGameServerDeploymentRequest const &, Options)

Gets details of a single game server deployment.

Parameters
Name Description
request google::cloud::gaming::v1::GetGameServerDeploymentRequest 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.GetGameServerDeploymentRequest. 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::GameServerDeployment >

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

CreateGameServerDeployment(std::string const &, google::cloud::gaming::v1::GameServerDeployment const &, Options)

Creates a new game server deployment 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}.

game_server_deployment google::cloud::gaming::v1::GameServerDeployment const &

Required. The game server delpoyment 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::GameServerDeployment > >

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.GameServerDeployment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateGameServerDeployment(google::cloud::gaming::v1::CreateGameServerDeploymentRequest const &, Options)

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

Parameters
Name Description
request google::cloud::gaming::v1::CreateGameServerDeploymentRequest 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.CreateGameServerDeploymentRequest. 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::GameServerDeployment > >

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.GameServerDeployment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteGameServerDeployment(std::string const &, Options)

Deletes a single game server deployment.

Parameters
Name Description
name std::string const &

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

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.

DeleteGameServerDeployment(google::cloud::gaming::v1::DeleteGameServerDeploymentRequest const &, Options)

Deletes a single game server deployment.

Parameters
Name Description
request google::cloud::gaming::v1::DeleteGameServerDeploymentRequest 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.DeleteGameServerDeploymentRequest. 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.

UpdateGameServerDeployment(google::cloud::gaming::v1::GameServerDeployment const &, google::protobuf::FieldMask const &, Options)

Patches a game server deployment.

Parameters
Name Description
game_server_deployment google::cloud::gaming::v1::GameServerDeployment const &

Required. The game server delpoyment 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::GameServerDeployment > >

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.GameServerDeployment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateGameServerDeployment(google::cloud::gaming::v1::UpdateGameServerDeploymentRequest const &, Options)

Patches a game server deployment.

Parameters
Name Description
request google::cloud::gaming::v1::UpdateGameServerDeploymentRequest 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.UpdateGameServerDeploymentRequest. 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::GameServerDeployment > >

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.GameServerDeployment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetGameServerDeploymentRollout(std::string const &, Options)

Gets details a single game server deployment rollout.

Parameters
Name Description
name std::string const &

Required. The name of the game server delpoyment to retrieve, in the following form: projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout.

opts Options

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

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

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

GetGameServerDeploymentRollout(google::cloud::gaming::v1::GetGameServerDeploymentRolloutRequest const &, Options)

Gets details a single game server deployment rollout.

Parameters
Name Description
request google::cloud::gaming::v1::GetGameServerDeploymentRolloutRequest 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.GetGameServerDeploymentRolloutRequest. 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::GameServerDeploymentRollout >

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

UpdateGameServerDeploymentRollout(google::cloud::gaming::v1::GameServerDeploymentRollout const &, google::protobuf::FieldMask const &, Options)

Patches a single game server deployment rollout.

The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters
Name Description
rollout google::cloud::gaming::v1::GameServerDeploymentRollout const &

Required. The game server delpoyment rollout 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::GameServerDeployment > >

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.GameServerDeployment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateGameServerDeploymentRollout(google::cloud::gaming::v1::UpdateGameServerDeploymentRolloutRequest const &, Options)

Patches a single game server deployment rollout.

The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters
Name Description
request google::cloud::gaming::v1::UpdateGameServerDeploymentRolloutRequest 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.UpdateGameServerDeploymentRolloutRequest. 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::GameServerDeployment > >

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.GameServerDeployment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PreviewGameServerDeploymentRollout(google::cloud::gaming::v1::PreviewGameServerDeploymentRolloutRequest const &, Options)

Previews the game server deployment rollout.

This API does not mutate the rollout resource.

Parameters
Name Description
request google::cloud::gaming::v1::PreviewGameServerDeploymentRolloutRequest 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.PreviewGameServerDeploymentRolloutRequest. 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::PreviewGameServerDeploymentRolloutResponse >

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

FetchDeploymentState(google::cloud::gaming::v1::FetchDeploymentStateRequest const &, Options)

Retrieves information about the current state of the game server deployment.

Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

Parameters
Name Description
request google::cloud::gaming::v1::FetchDeploymentStateRequest 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.FetchDeploymentStateRequest. 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::FetchDeploymentStateResponse >

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