com.google.cloud.gaming.v1beta

Class GameServerDeploymentsServiceClient

java.lang.Object

com.google.cloud.gaming.v1beta.GameServerDeploymentsServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class GameServerDeploymentsServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GameServerDeploymentName name =
       GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
   GameServerDeployment response =
       gameServerDeploymentsServiceClient.getGameServerDeployment(name);
 }
 

Note: close() needs to be called on the GameServerDeploymentsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of GameServerDeploymentsServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GameServerDeploymentsServiceSettings gameServerDeploymentsServiceSettings =
     GameServerDeploymentsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create(gameServerDeploymentsServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GameServerDeploymentsServiceSettings gameServerDeploymentsServiceSettings =
     GameServerDeploymentsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create(gameServerDeploymentsServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GameServerDeploymentsServiceSettings gameServerDeploymentsServiceSettings =
     GameServerDeploymentsServiceSettings.newHttpJsonBuilder().build();
 GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create(gameServerDeploymentsServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GameServerDeploymentsServiceClient.ListGameServerDeploymentsFixedSizeCollection
static class	GameServerDeploymentsServiceClient.ListGameServerDeploymentsPage
static class	GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GameServerDeploymentsServiceClient(GameServerDeploymentsServiceSettings settings) Constructs an instance of GameServerDeploymentsServiceClient, using the given settings.
protected	GameServerDeploymentsServiceClient(GameServerDeploymentsServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static GameServerDeploymentsServiceClient	create() Constructs an instance of GameServerDeploymentsServiceClient with default settings.
static GameServerDeploymentsServiceClient	create(GameServerDeploymentsServiceSettings settings) Constructs an instance of GameServerDeploymentsServiceClient, using the given settings.
static GameServerDeploymentsServiceClient	create(GameServerDeploymentsServiceStub stub) Constructs an instance of GameServerDeploymentsServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata>	createGameServerDeploymentAsync(CreateGameServerDeploymentRequest request) Creates a new game server deployment in a given project and location.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata>	createGameServerDeploymentAsync(LocationName parent, GameServerDeployment gameServerDeployment) Creates a new game server deployment in a given project and location.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata>	createGameServerDeploymentAsync(String parent, GameServerDeployment gameServerDeployment) Creates a new game server deployment in a given project and location.
com.google.api.gax.rpc.UnaryCallable<CreateGameServerDeploymentRequest,com.google.longrunning.Operation>	createGameServerDeploymentCallable() Creates a new game server deployment in a given project and location.
com.google.api.gax.rpc.OperationCallable<CreateGameServerDeploymentRequest,GameServerDeployment,OperationMetadata>	createGameServerDeploymentOperationCallable() Creates a new game server deployment in a given project and location.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest request) Deletes a single game server deployment.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteGameServerDeploymentAsync(GameServerDeploymentName name) Deletes a single game server deployment.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteGameServerDeploymentAsync(String name) Deletes a single game server deployment.
com.google.api.gax.rpc.UnaryCallable<DeleteGameServerDeploymentRequest,com.google.longrunning.Operation>	deleteGameServerDeploymentCallable() Deletes a single game server deployment.
com.google.api.gax.rpc.OperationCallable<DeleteGameServerDeploymentRequest,com.google.protobuf.Empty,OperationMetadata>	deleteGameServerDeploymentOperationCallable() Deletes a single game server deployment.
FetchDeploymentStateResponse	fetchDeploymentState(FetchDeploymentStateRequest request) Retrieves information about the current state of the game server deployment.
com.google.api.gax.rpc.UnaryCallable<FetchDeploymentStateRequest,FetchDeploymentStateResponse>	fetchDeploymentStateCallable() Retrieves information about the current state of the game server deployment.
GameServerDeployment	getGameServerDeployment(GameServerDeploymentName name) Gets details of a single game server deployment.
GameServerDeployment	getGameServerDeployment(GetGameServerDeploymentRequest request) Gets details of a single game server deployment.
GameServerDeployment	getGameServerDeployment(String name) Gets details of a single game server deployment.
com.google.api.gax.rpc.UnaryCallable<GetGameServerDeploymentRequest,GameServerDeployment>	getGameServerDeploymentCallable() Gets details of a single game server deployment.
GameServerDeploymentRollout	getGameServerDeploymentRollout(GameServerDeploymentName name) Gets details a single game server deployment rollout.
GameServerDeploymentRollout	getGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest request) Gets details a single game server deployment rollout.
GameServerDeploymentRollout	getGameServerDeploymentRollout(String name) Gets details a single game server deployment rollout.
com.google.api.gax.rpc.UnaryCallable<GetGameServerDeploymentRolloutRequest,GameServerDeploymentRollout>	getGameServerDeploymentRolloutCallable() Gets details a single game server deployment rollout.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
GameServerDeploymentsServiceSettings	getSettings()
GameServerDeploymentsServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse	listGameServerDeployments(ListGameServerDeploymentsRequest request) Lists game server deployments in a given project and location.
GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse	listGameServerDeployments(LocationName parent) Lists game server deployments in a given project and location.
GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse	listGameServerDeployments(String parent) Lists game server deployments in a given project and location.
com.google.api.gax.rpc.UnaryCallable<ListGameServerDeploymentsRequest,ListGameServerDeploymentsResponse>	listGameServerDeploymentsCallable() Lists game server deployments in a given project and location.
com.google.api.gax.rpc.UnaryCallable<ListGameServerDeploymentsRequest,GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse>	listGameServerDeploymentsPagedCallable() Lists game server deployments in a given project and location.
PreviewGameServerDeploymentRolloutResponse	previewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest request) Previews the game server deployment rollout.
com.google.api.gax.rpc.UnaryCallable<PreviewGameServerDeploymentRolloutRequest,PreviewGameServerDeploymentRolloutResponse>	previewGameServerDeploymentRolloutCallable() Previews the game server deployment rollout.
void	shutdown()
void	shutdownNow()
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata>	updateGameServerDeploymentAsync(GameServerDeployment gameServerDeployment, com.google.protobuf.FieldMask updateMask) Patches a game server deployment.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata>	updateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest request) Patches a game server deployment.
com.google.api.gax.rpc.UnaryCallable<UpdateGameServerDeploymentRequest,com.google.longrunning.Operation>	updateGameServerDeploymentCallable() Patches a game server deployment.
com.google.api.gax.rpc.OperationCallable<UpdateGameServerDeploymentRequest,GameServerDeployment,OperationMetadata>	updateGameServerDeploymentOperationCallable() Patches a game server deployment.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata>	updateGameServerDeploymentRolloutAsync(GameServerDeploymentRollout rollout, com.google.protobuf.FieldMask updateMask) Patches a single game server deployment rollout.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata>	updateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest request) Patches a single game server deployment rollout.
com.google.api.gax.rpc.UnaryCallable<UpdateGameServerDeploymentRolloutRequest,com.google.longrunning.Operation>	updateGameServerDeploymentRolloutCallable() Patches a single game server deployment rollout.
com.google.api.gax.rpc.OperationCallable<UpdateGameServerDeploymentRolloutRequest,GameServerDeployment,OperationMetadata>	updateGameServerDeploymentRolloutOperationCallable() Patches a single game server deployment rollout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GameServerDeploymentsServiceClient

protected GameServerDeploymentsServiceClient(GameServerDeploymentsServiceSettings settings)
                                      throws IOException

Constructs an instance of GameServerDeploymentsServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

GameServerDeploymentsServiceClient

protected GameServerDeploymentsServiceClient(GameServerDeploymentsServiceStub stub)

Method Detail

create

public static final GameServerDeploymentsServiceClient create()
                                                       throws IOException

Constructs an instance of GameServerDeploymentsServiceClient with default settings.

Throws:

IOException

create

public static final GameServerDeploymentsServiceClient create(GameServerDeploymentsServiceSettings settings)
                                                       throws IOException

Constructs an instance of GameServerDeploymentsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final GameServerDeploymentsServiceClient create(GameServerDeploymentsServiceStub stub)

Constructs an instance of GameServerDeploymentsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(GameServerDeploymentsServiceSettings).

getSettings

public final GameServerDeploymentsServiceSettings getSettings()

getStub

public GameServerDeploymentsServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

listGameServerDeployments

public final GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse listGameServerDeployments(LocationName parent)

Lists game server deployments in a given project and location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (GameServerDeployment element :
       gameServerDeploymentsServiceClient.listGameServerDeployments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGameServerDeployments

public final GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse listGameServerDeployments(String parent)

Lists game server deployments in a given project and location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (GameServerDeployment element :
       gameServerDeploymentsServiceClient.listGameServerDeployments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGameServerDeployments

public final GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse listGameServerDeployments(ListGameServerDeploymentsRequest request)

Lists game server deployments in a given project and location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   ListGameServerDeploymentsRequest request =
       ListGameServerDeploymentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (GameServerDeployment element :
       gameServerDeploymentsServiceClient.listGameServerDeployments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listGameServerDeploymentsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGameServerDeploymentsRequest,GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse> listGameServerDeploymentsPagedCallable()

Lists game server deployments in a given project and location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   ListGameServerDeploymentsRequest request =
       ListGameServerDeploymentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<GameServerDeployment> future =
       gameServerDeploymentsServiceClient
           .listGameServerDeploymentsPagedCallable()
           .futureCall(request);
   // Do something.
   for (GameServerDeployment element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listGameServerDeploymentsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGameServerDeploymentsRequest,ListGameServerDeploymentsResponse> listGameServerDeploymentsCallable()

Lists game server deployments in a given project and location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   ListGameServerDeploymentsRequest request =
       ListGameServerDeploymentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListGameServerDeploymentsResponse response =
         gameServerDeploymentsServiceClient.listGameServerDeploymentsCallable().call(request);
     for (GameServerDeployment element : response.getGameServerDeploymentsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getGameServerDeployment

public final GameServerDeployment getGameServerDeployment(GameServerDeploymentName name)

Gets details of a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GameServerDeploymentName name =
       GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
   GameServerDeployment response =
       gameServerDeploymentsServiceClient.getGameServerDeployment(name);
 }
 

Parameters:

name - Required. The name of the game server delpoyment to retrieve. Uses the form:

`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGameServerDeployment

public final GameServerDeployment getGameServerDeployment(String name)

Gets details of a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   String name =
       GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient.getGameServerDeployment(name);
 }
 

Parameters:

name - Required. The name of the game server delpoyment to retrieve. Uses the form:

`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGameServerDeployment

public final GameServerDeployment getGameServerDeployment(GetGameServerDeploymentRequest request)

Gets details of a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GetGameServerDeploymentRequest request =
       GetGameServerDeploymentRequest.newBuilder()
           .setName(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .build();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient.getGameServerDeployment(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGameServerDeploymentCallable

public final com.google.api.gax.rpc.UnaryCallable<GetGameServerDeploymentRequest,GameServerDeployment> getGameServerDeploymentCallable()

Gets details of a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GetGameServerDeploymentRequest request =
       GetGameServerDeploymentRequest.newBuilder()
           .setName(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .build();
   ApiFuture<GameServerDeployment> future =
       gameServerDeploymentsServiceClient.getGameServerDeploymentCallable().futureCall(request);
   // Do something.
   GameServerDeployment response = future.get();
 }
 

createGameServerDeploymentAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata> createGameServerDeploymentAsync(LocationName parent,
                                                                                                                                    GameServerDeployment gameServerDeployment)

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient
           .createGameServerDeploymentAsync(parent, gameServerDeployment)
           .get();
 }
 

Parameters:

parent - Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`.

gameServerDeployment - Required. The game server delpoyment resource to be created.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createGameServerDeploymentAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata> createGameServerDeploymentAsync(String parent,
                                                                                                                                    GameServerDeployment gameServerDeployment)

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient
           .createGameServerDeploymentAsync(parent, gameServerDeployment)
           .get();
 }
 

Parameters:

parent - Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`.

gameServerDeployment - Required. The game server delpoyment resource to be created.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createGameServerDeploymentAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata> createGameServerDeploymentAsync(CreateGameServerDeploymentRequest request)

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   CreateGameServerDeploymentRequest request =
       CreateGameServerDeploymentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeploymentId("deploymentId-136894784")
           .setGameServerDeployment(GameServerDeployment.newBuilder().build())
           .build();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient.createGameServerDeploymentAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createGameServerDeploymentOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateGameServerDeploymentRequest,GameServerDeployment,OperationMetadata> createGameServerDeploymentOperationCallable()

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   CreateGameServerDeploymentRequest request =
       CreateGameServerDeploymentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeploymentId("deploymentId-136894784")
           .setGameServerDeployment(GameServerDeployment.newBuilder().build())
           .build();
   OperationFuture<GameServerDeployment, OperationMetadata> future =
       gameServerDeploymentsServiceClient
           .createGameServerDeploymentOperationCallable()
           .futureCall(request);
   // Do something.
   GameServerDeployment response = future.get();
 }
 

createGameServerDeploymentCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateGameServerDeploymentRequest,com.google.longrunning.Operation> createGameServerDeploymentCallable()

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   CreateGameServerDeploymentRequest request =
       CreateGameServerDeploymentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDeploymentId("deploymentId-136894784")
           .setGameServerDeployment(GameServerDeployment.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       gameServerDeploymentsServiceClient
           .createGameServerDeploymentCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

deleteGameServerDeploymentAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteGameServerDeploymentAsync(GameServerDeploymentName name)

Deletes a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GameServerDeploymentName name =
       GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
   gameServerDeploymentsServiceClient.deleteGameServerDeploymentAsync(name).get();
 }
 

Parameters:

name - Required. The name of the game server delpoyment to delete. Uses the form:

`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGameServerDeploymentAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteGameServerDeploymentAsync(String name)

Deletes a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   String name =
       GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString();
   gameServerDeploymentsServiceClient.deleteGameServerDeploymentAsync(name).get();
 }
 

Parameters:

name - Required. The name of the game server delpoyment to delete. Uses the form:

`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGameServerDeploymentAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest request)

Deletes a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   DeleteGameServerDeploymentRequest request =
       DeleteGameServerDeploymentRequest.newBuilder()
           .setName(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .build();
   gameServerDeploymentsServiceClient.deleteGameServerDeploymentAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGameServerDeploymentOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteGameServerDeploymentRequest,com.google.protobuf.Empty,OperationMetadata> deleteGameServerDeploymentOperationCallable()

Deletes a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   DeleteGameServerDeploymentRequest request =
       DeleteGameServerDeploymentRequest.newBuilder()
           .setName(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       gameServerDeploymentsServiceClient
           .deleteGameServerDeploymentOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 

deleteGameServerDeploymentCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteGameServerDeploymentRequest,com.google.longrunning.Operation> deleteGameServerDeploymentCallable()

Deletes a single game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   DeleteGameServerDeploymentRequest request =
       DeleteGameServerDeploymentRequest.newBuilder()
           .setName(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .build();
   ApiFuture<Operation> future =
       gameServerDeploymentsServiceClient
           .deleteGameServerDeploymentCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 

updateGameServerDeploymentAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata> updateGameServerDeploymentAsync(GameServerDeployment gameServerDeployment,
                                                                                                                                    com.google.protobuf.FieldMask updateMask)

Patches a game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient
           .updateGameServerDeploymentAsync(gameServerDeployment, updateMask)
           .get();
 }
 

Parameters:

gameServerDeployment - Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated.

updateMask - 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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateGameServerDeploymentAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata> updateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest request)

Patches a game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   UpdateGameServerDeploymentRequest request =
       UpdateGameServerDeploymentRequest.newBuilder()
           .setGameServerDeployment(GameServerDeployment.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient.updateGameServerDeploymentAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateGameServerDeploymentOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UpdateGameServerDeploymentRequest,GameServerDeployment,OperationMetadata> updateGameServerDeploymentOperationCallable()

Patches a game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   UpdateGameServerDeploymentRequest request =
       UpdateGameServerDeploymentRequest.newBuilder()
           .setGameServerDeployment(GameServerDeployment.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<GameServerDeployment, OperationMetadata> future =
       gameServerDeploymentsServiceClient
           .updateGameServerDeploymentOperationCallable()
           .futureCall(request);
   // Do something.
   GameServerDeployment response = future.get();
 }
 

updateGameServerDeploymentCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateGameServerDeploymentRequest,com.google.longrunning.Operation> updateGameServerDeploymentCallable()

Patches a game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   UpdateGameServerDeploymentRequest request =
       UpdateGameServerDeploymentRequest.newBuilder()
           .setGameServerDeployment(GameServerDeployment.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       gameServerDeploymentsServiceClient
           .updateGameServerDeploymentCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

getGameServerDeploymentRollout

public final GameServerDeploymentRollout getGameServerDeploymentRollout(GameServerDeploymentName name)

Gets details a single game server deployment rollout.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GameServerDeploymentName name =
       GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
   GameServerDeploymentRollout response =
       gameServerDeploymentsServiceClient.getGameServerDeploymentRollout(name);
 }
 

Parameters:

name - Required. The name of the game server delpoyment to retrieve. Uses the form:

`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGameServerDeploymentRollout

public final GameServerDeploymentRollout getGameServerDeploymentRollout(String name)

Gets details a single game server deployment rollout.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   String name =
       GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString();
   GameServerDeploymentRollout response =
       gameServerDeploymentsServiceClient.getGameServerDeploymentRollout(name);
 }
 

Parameters:

name - Required. The name of the game server delpoyment to retrieve. Uses the form:

`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGameServerDeploymentRollout

public final GameServerDeploymentRollout getGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest request)

Gets details a single game server deployment rollout.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GetGameServerDeploymentRolloutRequest request =
       GetGameServerDeploymentRolloutRequest.newBuilder()
           .setName(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .build();
   GameServerDeploymentRollout response =
       gameServerDeploymentsServiceClient.getGameServerDeploymentRollout(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getGameServerDeploymentRolloutCallable

public final com.google.api.gax.rpc.UnaryCallable<GetGameServerDeploymentRolloutRequest,GameServerDeploymentRollout> getGameServerDeploymentRolloutCallable()

Gets details a single game server deployment rollout.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GetGameServerDeploymentRolloutRequest request =
       GetGameServerDeploymentRolloutRequest.newBuilder()
           .setName(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .build();
   ApiFuture<GameServerDeploymentRollout> future =
       gameServerDeploymentsServiceClient
           .getGameServerDeploymentRolloutCallable()
           .futureCall(request);
   // Do something.
   GameServerDeploymentRollout response = future.get();
 }
 

updateGameServerDeploymentRolloutAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata> updateGameServerDeploymentRolloutAsync(GameServerDeploymentRollout rollout,
                                                                                                                                           com.google.protobuf.FieldMask updateMask)

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   GameServerDeploymentRollout rollout = GameServerDeploymentRollout.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient
           .updateGameServerDeploymentRolloutAsync(rollout, updateMask)
           .get();
 }
 

Parameters:

rollout - Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated.

updateMask - 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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateGameServerDeploymentRolloutAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,OperationMetadata> updateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest request)

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   UpdateGameServerDeploymentRolloutRequest request =
       UpdateGameServerDeploymentRolloutRequest.newBuilder()
           .setRollout(GameServerDeploymentRollout.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   GameServerDeployment response =
       gameServerDeploymentsServiceClient.updateGameServerDeploymentRolloutAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateGameServerDeploymentRolloutOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UpdateGameServerDeploymentRolloutRequest,GameServerDeployment,OperationMetadata> updateGameServerDeploymentRolloutOperationCallable()

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   UpdateGameServerDeploymentRolloutRequest request =
       UpdateGameServerDeploymentRolloutRequest.newBuilder()
           .setRollout(GameServerDeploymentRollout.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<GameServerDeployment, OperationMetadata> future =
       gameServerDeploymentsServiceClient
           .updateGameServerDeploymentRolloutOperationCallable()
           .futureCall(request);
   // Do something.
   GameServerDeployment response = future.get();
 }
 

updateGameServerDeploymentRolloutCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateGameServerDeploymentRolloutRequest,com.google.longrunning.Operation> updateGameServerDeploymentRolloutCallable()

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   UpdateGameServerDeploymentRolloutRequest request =
       UpdateGameServerDeploymentRolloutRequest.newBuilder()
           .setRollout(GameServerDeploymentRollout.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       gameServerDeploymentsServiceClient
           .updateGameServerDeploymentRolloutCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

previewGameServerDeploymentRollout

public final PreviewGameServerDeploymentRolloutResponse previewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest request)

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   PreviewGameServerDeploymentRolloutRequest request =
       PreviewGameServerDeploymentRolloutRequest.newBuilder()
           .setRollout(GameServerDeploymentRollout.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setPreviewTime(Timestamp.newBuilder().build())
           .build();
   PreviewGameServerDeploymentRolloutResponse response =
       gameServerDeploymentsServiceClient.previewGameServerDeploymentRollout(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

previewGameServerDeploymentRolloutCallable

public final com.google.api.gax.rpc.UnaryCallable<PreviewGameServerDeploymentRolloutRequest,PreviewGameServerDeploymentRolloutResponse> previewGameServerDeploymentRolloutCallable()

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   PreviewGameServerDeploymentRolloutRequest request =
       PreviewGameServerDeploymentRolloutRequest.newBuilder()
           .setRollout(GameServerDeploymentRollout.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setPreviewTime(Timestamp.newBuilder().build())
           .build();
   ApiFuture<PreviewGameServerDeploymentRolloutResponse> future =
       gameServerDeploymentsServiceClient
           .previewGameServerDeploymentRolloutCallable()
           .futureCall(request);
   // Do something.
   PreviewGameServerDeploymentRolloutResponse response = future.get();
 }
 

fetchDeploymentState

public final FetchDeploymentStateResponse fetchDeploymentState(FetchDeploymentStateRequest request)

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   FetchDeploymentStateRequest request =
       FetchDeploymentStateRequest.newBuilder().setName("name3373707").build();
   FetchDeploymentStateResponse response =
       gameServerDeploymentsServiceClient.fetchDeploymentState(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

fetchDeploymentStateCallable

public final com.google.api.gax.rpc.UnaryCallable<FetchDeploymentStateRequest,FetchDeploymentStateResponse> fetchDeploymentStateCallable()

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.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create()) {
   FetchDeploymentStateRequest request =
       FetchDeploymentStateRequest.newBuilder().setName("name3373707").build();
   ApiFuture<FetchDeploymentStateResponse> future =
       gameServerDeploymentsServiceClient.fetchDeploymentStateCallable().futureCall(request);
   // Do something.
   FetchDeploymentStateResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException