com.google.cloud.gaming.v1alpha

Class GameServerDeploymentsServiceClient

java.lang.Object

com.google.cloud.gaming.v1alpha.GameServerDeploymentsServiceClient

All Implemented Interfaces:

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

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

Service Description: The game server deployment is used to configure the deployment of game server software to Agones Fleets in game server clusters.

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:

 
 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GameServerDeployment response = gameServerDeploymentsServiceClient.getGameServerDeployment(formattedName);
 }
 
 

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:

 
 GameServerDeploymentsServiceSettings gameServerDeploymentsServiceSettings =
     GameServerDeploymentsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create(gameServerDeploymentsServiceSettings);
 
 

To customize the endpoint:

 
 GameServerDeploymentsServiceSettings gameServerDeploymentsServiceSettings =
     GameServerDeploymentsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
     GameServerDeploymentsServiceClient.create(gameServerDeploymentsServiceSettings);
 
 

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()
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	commitRolloutAsync(CommitRolloutRequest request) Commits the ongoing game server deployment rollout by setting the rollout percentage to 100 in all clusters whose labels match labels in the game server template.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	commitRolloutAsync(String name) Commits the ongoing game server deployment rollout by setting the rollout percentage to 100 in all clusters whose labels match labels in the game server template.
com.google.api.gax.rpc.UnaryCallable<CommitRolloutRequest,com.google.longrunning.Operation>	commitRolloutCallable() Commits the ongoing game server deployment rollout by setting the rollout percentage to 100 in all clusters whose labels match labels in the game server template.
com.google.api.gax.rpc.OperationCallable<CommitRolloutRequest,GameServerDeployment,Empty>	commitRolloutOperationCallable() Commits the ongoing game server deployment rollout by setting the rollout percentage to 100 in all clusters whose labels match labels in the game server template.
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,Empty>	createGameServerDeploymentAsync(CreateGameServerDeploymentRequest request) Creates a new game server deployment in a given project and location.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	createGameServerDeploymentAsync(String parent, String deploymentId, 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,Empty>	createGameServerDeploymentOperationCallable() Creates a new game server deployment in a given project and location.
com.google.api.gax.longrunning.OperationFuture<Empty,Empty>	deleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest request) Deletes a single game server deployment.
com.google.api.gax.longrunning.OperationFuture<Empty,Empty>	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,Empty,Empty>	deleteGameServerDeploymentOperationCallable() Deletes a single game server deployment.
static String	formatGameServerDeploymentName(String project, String location, String gameServerDeployment) Deprecated. Use the GameServerDeploymentName class instead.
static String	formatLocationName(String project, String location) Deprecated. Use the LocationName class instead.
DeploymentTarget	getDeploymentTarget(GetDeploymentTargetRequest request) Retrieves information on the rollout target of the deployment, e.g.
DeploymentTarget	getDeploymentTarget(String name) Retrieves information on the rollout target of the deployment, e.g.
com.google.api.gax.rpc.UnaryCallable<GetDeploymentTargetRequest,DeploymentTarget>	getDeploymentTargetCallable() Retrieves information on the rollout target of the deployment, e.g.
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.
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(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.
static String	parseGameServerDeploymentFromGameServerDeploymentName(String gameServerDeploymentName) Deprecated. Use the GameServerDeploymentName class instead.
static String	parseLocationFromGameServerDeploymentName(String gameServerDeploymentName) Deprecated. Use the GameServerDeploymentName class instead.
static String	parseLocationFromLocationName(String locationName) Deprecated. Use the LocationName class instead.
static String	parseProjectFromGameServerDeploymentName(String gameServerDeploymentName) Deprecated. Use the GameServerDeploymentName class instead.
static String	parseProjectFromLocationName(String locationName) Deprecated. Use the LocationName class instead.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	revertRolloutAsync(RevertRolloutRequest request) Rolls back the ongoing game server deployment rollout by setting the rollout percentage to 0 in all clusters whose labels match labels in the game server template.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	revertRolloutAsync(String name) Rolls back the ongoing game server deployment rollout by setting the rollout percentage to 0 in all clusters whose labels match labels in the game server template.
com.google.api.gax.rpc.UnaryCallable<RevertRolloutRequest,com.google.longrunning.Operation>	revertRolloutCallable() Rolls back the ongoing game server deployment rollout by setting the rollout percentage to 0 in all clusters whose labels match labels in the game server template.
com.google.api.gax.rpc.OperationCallable<RevertRolloutRequest,GameServerDeployment,Empty>	revertRolloutOperationCallable() Rolls back the ongoing game server deployment rollout by setting the rollout percentage to 0 in all clusters whose labels match labels in the game server template.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	setRolloutTargetAsync(SetRolloutTargetRequest request) Sets rollout target for the ongoing game server deployment rollout in the specified clusters and based on the given rollout percentage.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	setRolloutTargetAsync(String name, List<ClusterPercentageSelector> clusterPercentageSelector) Sets rollout target for the ongoing game server deployment rollout in the specified clusters and based on the given rollout percentage.
com.google.api.gax.rpc.UnaryCallable<SetRolloutTargetRequest,com.google.longrunning.Operation>	setRolloutTargetCallable() Sets rollout target for the ongoing game server deployment rollout in the specified clusters and based on the given rollout percentage.
com.google.api.gax.rpc.OperationCallable<SetRolloutTargetRequest,GameServerDeployment,Empty>	setRolloutTargetOperationCallable() Sets rollout target for the ongoing game server deployment rollout in the specified clusters and based on the given rollout percentage.
void	shutdown()
void	shutdownNow()
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	startRolloutAsync(StartRolloutRequest request) Starts rollout of this game server deployment based on the given game server template.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	startRolloutAsync(String name, GameServerTemplate newGameServerTemplate) Starts rollout of this game server deployment based on the given game server template.
com.google.api.gax.rpc.UnaryCallable<StartRolloutRequest,com.google.longrunning.Operation>	startRolloutCallable() Starts rollout of this game server deployment based on the given game server template.
com.google.api.gax.rpc.OperationCallable<StartRolloutRequest,GameServerDeployment,Empty>	startRolloutOperationCallable() Starts rollout of this game server deployment based on the given game server template.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	updateGameServerDeploymentAsync(GameServerDeployment gameServerDeployment, FieldMask updateMask) Patches a game server deployment.
com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty>	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,Empty>	updateGameServerDeploymentOperationCallable() Patches a game server deployment.

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected GameServerDeploymentsServiceClient(GameServerDeploymentsServiceStub stub)

Method Detail

formatGameServerDeploymentName

@Deprecated
public static final String formatGameServerDeploymentName(String project,
                                                                      String location,
                                                                      String gameServerDeployment)

Deprecated. Use the GameServerDeploymentName class instead.

Formats a string containing the fully-qualified path to represent a game_server_deployment resource.

formatLocationName

@Deprecated
public static final String formatLocationName(String project,
                                                          String location)

Deprecated. Use the LocationName class instead.

Formats a string containing the fully-qualified path to represent a location resource.

parseProjectFromGameServerDeploymentName

@Deprecated
public static final String parseProjectFromGameServerDeploymentName(String gameServerDeploymentName)

Deprecated. Use the GameServerDeploymentName class instead.

Parses the project from the given fully-qualified path which represents a game_server_deployment resource.

parseLocationFromGameServerDeploymentName

@Deprecated
public static final String parseLocationFromGameServerDeploymentName(String gameServerDeploymentName)

Deprecated. Use the GameServerDeploymentName class instead.

Parses the location from the given fully-qualified path which represents a game_server_deployment resource.

parseGameServerDeploymentFromGameServerDeploymentName

@Deprecated
public static final String parseGameServerDeploymentFromGameServerDeploymentName(String gameServerDeploymentName)

Deprecated. Use the GameServerDeploymentName class instead.

Parses the game_server_deployment from the given fully-qualified path which represents a game_server_deployment resource.

parseProjectFromLocationName

@Deprecated
public static final String parseProjectFromLocationName(String locationName)

Deprecated. Use the LocationName class instead.

Parses the project from the given fully-qualified path which represents a location resource.

parseLocationFromLocationName

@Deprecated
public static final String parseLocationFromLocationName(String locationName)

Deprecated. Use the LocationName class instead.

Parses the location from the given fully-qualified path which represents a location resource.

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use GameServerDeploymentsServiceSettings}.

getSettings

public final GameServerDeploymentsServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public GameServerDeploymentsServiceStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

listGameServerDeployments

public final GameServerDeploymentsServiceClient.ListGameServerDeploymentsPagedResponse listGameServerDeployments(String parent)

Lists game server deployments in a given project and location.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedParent = GameServerDeploymentsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   for (GameServerDeployment element : gameServerDeploymentsServiceClient.listGameServerDeployments(formattedParent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent resource name, using the form: `projects/{project_id}/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:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedParent = GameServerDeploymentsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   ListGameServerDeploymentsRequest request = ListGameServerDeploymentsRequest.newBuilder()
     .setParent(formattedParent)
     .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:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedParent = GameServerDeploymentsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   ListGameServerDeploymentsRequest request = ListGameServerDeploymentsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListGameServerDeploymentsPagedResponse> 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:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedParent = GameServerDeploymentsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   ListGameServerDeploymentsRequest request = ListGameServerDeploymentsRequest.newBuilder()
     .setParent(formattedParent)
     .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(String name)

Gets details of a single game server deployment.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GameServerDeployment response = gameServerDeploymentsServiceClient.getGameServerDeployment(formattedName);
 }
 

Parameters:

name - Required. The name of the game server deployment to retrieve, using the form:

`projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}`

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:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GetGameServerDeploymentRequest request = GetGameServerDeploymentRequest.newBuilder()
     .setName(formattedName)
     .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:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GetGameServerDeploymentRequest request = GetGameServerDeploymentRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<GameServerDeployment> future = gameServerDeploymentsServiceClient.getGameServerDeploymentCallable().futureCall(request);
   // Do something
   GameServerDeployment response = future.get();
 }
 

createGameServerDeploymentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> createGameServerDeploymentAsync(String parent,
                                                                                                                                                                                                                                  String deploymentId,
                                                                                                                                                                                                                                  GameServerDeployment gameServerDeployment)

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

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedParent = GameServerDeploymentsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String deploymentId = "";
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   GameServerDeployment response = gameServerDeploymentsServiceClient.createGameServerDeploymentAsync(formattedParent, deploymentId, gameServerDeployment).get();
 }
 

Parameters:

parent - Required. The parent resource name, using the form: `projects/{project_id}/locations/{location}`.

deploymentId - Required. The ID of the game server deployment resource to be created.

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

Throws:

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

createGameServerDeploymentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> createGameServerDeploymentAsync(CreateGameServerDeploymentRequest request)

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

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedParent = GameServerDeploymentsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String deploymentId = "";
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   CreateGameServerDeploymentRequest request = CreateGameServerDeploymentRequest.newBuilder()
     .setParent(formattedParent)
     .setDeploymentId(deploymentId)
     .setGameServerDeployment(gameServerDeployment)
     .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

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<CreateGameServerDeploymentRequest,GameServerDeployment,Empty> createGameServerDeploymentOperationCallable()

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

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedParent = GameServerDeploymentsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String deploymentId = "";
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   CreateGameServerDeploymentRequest request = CreateGameServerDeploymentRequest.newBuilder()
     .setParent(formattedParent)
     .setDeploymentId(deploymentId)
     .setGameServerDeployment(gameServerDeployment)
     .build();
   OperationFuture<GameServerDeployment, Empty> 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:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedParent = GameServerDeploymentsServiceClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String deploymentId = "";
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   CreateGameServerDeploymentRequest request = CreateGameServerDeploymentRequest.newBuilder()
     .setParent(formattedParent)
     .setDeploymentId(deploymentId)
     .setGameServerDeployment(gameServerDeployment)
     .build();
   ApiFuture<Operation> future = gameServerDeploymentsServiceClient.createGameServerDeploymentCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteGameServerDeploymentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Empty,Empty> deleteGameServerDeploymentAsync(String name)

Deletes a single game server deployment.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   gameServerDeploymentsServiceClient.deleteGameServerDeploymentAsync(formattedName).get();
 }
 

Parameters:

name - Required. The name of the game server deployment to delete, using the form:

`projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}`

Throws:

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

deleteGameServerDeploymentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Empty,Empty> deleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest request)

Deletes a single game server deployment.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   DeleteGameServerDeploymentRequest request = DeleteGameServerDeploymentRequest.newBuilder()
     .setName(formattedName)
     .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

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<DeleteGameServerDeploymentRequest,Empty,Empty> deleteGameServerDeploymentOperationCallable()

Deletes a single game server deployment.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   DeleteGameServerDeploymentRequest request = DeleteGameServerDeploymentRequest.newBuilder()
     .setName(formattedName)
     .build();
   OperationFuture<Empty, Empty> 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:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   DeleteGameServerDeploymentRequest request = DeleteGameServerDeploymentRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Operation> future = gameServerDeploymentsServiceClient.deleteGameServerDeploymentCallable().futureCall(request);
   // Do something
   future.get();
 }
 

updateGameServerDeploymentAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> updateGameServerDeploymentAsync(GameServerDeployment gameServerDeployment,
                                                                                                                                                                                                                                  FieldMask updateMask)

Patches a game server deployment.

Sample code:

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

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> updateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest request)

Patches a game server deployment.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateGameServerDeploymentRequest request = UpdateGameServerDeploymentRequest.newBuilder()
     .setGameServerDeployment(gameServerDeployment)
     .setUpdateMask(updateMask)
     .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

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<UpdateGameServerDeploymentRequest,GameServerDeployment,Empty> updateGameServerDeploymentOperationCallable()

Patches a game server deployment.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateGameServerDeploymentRequest request = UpdateGameServerDeploymentRequest.newBuilder()
     .setGameServerDeployment(gameServerDeployment)
     .setUpdateMask(updateMask)
     .build();
   OperationFuture<GameServerDeployment, Empty> 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:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   GameServerDeployment gameServerDeployment = GameServerDeployment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateGameServerDeploymentRequest request = UpdateGameServerDeploymentRequest.newBuilder()
     .setGameServerDeployment(gameServerDeployment)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<Operation> future = gameServerDeploymentsServiceClient.updateGameServerDeploymentCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

startRolloutAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> startRolloutAsync(String name,
                                                                                                                                                                                                                    GameServerTemplate newGameServerTemplate)

Starts rollout of this game server deployment based on the given game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GameServerTemplate newGameServerTemplate = GameServerTemplate.newBuilder().build();
   GameServerDeployment response = gameServerDeploymentsServiceClient.startRolloutAsync(formattedName, newGameServerTemplate).get();
 }
 

Parameters:

name - Required. The name of the game server deployment, using the form:

`projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}`

newGameServerTemplate - Required. The game server template for the new rollout.

Throws:

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

startRolloutAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> startRolloutAsync(StartRolloutRequest request)

Starts rollout of this game server deployment based on the given game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GameServerTemplate newGameServerTemplate = GameServerTemplate.newBuilder().build();
   StartRolloutRequest request = StartRolloutRequest.newBuilder()
     .setName(formattedName)
     .setNewGameServerTemplate(newGameServerTemplate)
     .build();
   GameServerDeployment response = gameServerDeploymentsServiceClient.startRolloutAsync(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

startRolloutOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<StartRolloutRequest,GameServerDeployment,Empty> startRolloutOperationCallable()

Starts rollout of this game server deployment based on the given game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GameServerTemplate newGameServerTemplate = GameServerTemplate.newBuilder().build();
   StartRolloutRequest request = StartRolloutRequest.newBuilder()
     .setName(formattedName)
     .setNewGameServerTemplate(newGameServerTemplate)
     .build();
   OperationFuture<GameServerDeployment, Empty> future = gameServerDeploymentsServiceClient.startRolloutOperationCallable().futureCall(request);
   // Do something
   GameServerDeployment response = future.get();
 }
 

startRolloutCallable

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

Starts rollout of this game server deployment based on the given game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GameServerTemplate newGameServerTemplate = GameServerTemplate.newBuilder().build();
   StartRolloutRequest request = StartRolloutRequest.newBuilder()
     .setName(formattedName)
     .setNewGameServerTemplate(newGameServerTemplate)
     .build();
   ApiFuture<Operation> future = gameServerDeploymentsServiceClient.startRolloutCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

setRolloutTargetAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> setRolloutTargetAsync(String name,
                                                                                                                                                                                                                        List<ClusterPercentageSelector> clusterPercentageSelector)

Sets rollout target for the ongoing game server deployment rollout in the specified clusters and based on the given rollout percentage. Default is 0.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   List<ClusterPercentageSelector> clusterPercentageSelector = new ArrayList<>();
   GameServerDeployment response = gameServerDeploymentsServiceClient.setRolloutTargetAsync(formattedName, clusterPercentageSelector).get();
 }
 

Parameters:

name - Required. The name of the game server deployment, using the form:

`projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}`

clusterPercentageSelector - Required. The percentage of game servers that should run the new game server template in the specified clusters. Default is 0.

Throws:

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

setRolloutTargetAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> setRolloutTargetAsync(SetRolloutTargetRequest request)

Sets rollout target for the ongoing game server deployment rollout in the specified clusters and based on the given rollout percentage. Default is 0.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   List<ClusterPercentageSelector> clusterPercentageSelector = new ArrayList<>();
   SetRolloutTargetRequest request = SetRolloutTargetRequest.newBuilder()
     .setName(formattedName)
     .addAllClusterPercentageSelector(clusterPercentageSelector)
     .build();
   GameServerDeployment response = gameServerDeploymentsServiceClient.setRolloutTargetAsync(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

setRolloutTargetOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<SetRolloutTargetRequest,GameServerDeployment,Empty> setRolloutTargetOperationCallable()

Sets rollout target for the ongoing game server deployment rollout in the specified clusters and based on the given rollout percentage. Default is 0.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   List<ClusterPercentageSelector> clusterPercentageSelector = new ArrayList<>();
   SetRolloutTargetRequest request = SetRolloutTargetRequest.newBuilder()
     .setName(formattedName)
     .addAllClusterPercentageSelector(clusterPercentageSelector)
     .build();
   OperationFuture<GameServerDeployment, Empty> future = gameServerDeploymentsServiceClient.setRolloutTargetOperationCallable().futureCall(request);
   // Do something
   GameServerDeployment response = future.get();
 }
 

setRolloutTargetCallable

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

Sets rollout target for the ongoing game server deployment rollout in the specified clusters and based on the given rollout percentage. Default is 0.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   List<ClusterPercentageSelector> clusterPercentageSelector = new ArrayList<>();
   SetRolloutTargetRequest request = SetRolloutTargetRequest.newBuilder()
     .setName(formattedName)
     .addAllClusterPercentageSelector(clusterPercentageSelector)
     .build();
   ApiFuture<Operation> future = gameServerDeploymentsServiceClient.setRolloutTargetCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

commitRolloutAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> commitRolloutAsync(String name)

Commits the ongoing game server deployment rollout by setting the rollout percentage to 100 in all clusters whose labels match labels in the game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GameServerDeployment response = gameServerDeploymentsServiceClient.commitRolloutAsync(formattedName).get();
 }
 

Parameters:

name - Required. The name of the game server deployment, using the form:

`projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}`

Throws:

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

commitRolloutAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> commitRolloutAsync(CommitRolloutRequest request)

Commits the ongoing game server deployment rollout by setting the rollout percentage to 100 in all clusters whose labels match labels in the game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   CommitRolloutRequest request = CommitRolloutRequest.newBuilder()
     .setName(formattedName)
     .build();
   GameServerDeployment response = gameServerDeploymentsServiceClient.commitRolloutAsync(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

commitRolloutOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<CommitRolloutRequest,GameServerDeployment,Empty> commitRolloutOperationCallable()

Commits the ongoing game server deployment rollout by setting the rollout percentage to 100 in all clusters whose labels match labels in the game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   CommitRolloutRequest request = CommitRolloutRequest.newBuilder()
     .setName(formattedName)
     .build();
   OperationFuture<GameServerDeployment, Empty> future = gameServerDeploymentsServiceClient.commitRolloutOperationCallable().futureCall(request);
   // Do something
   GameServerDeployment response = future.get();
 }
 

commitRolloutCallable

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

Commits the ongoing game server deployment rollout by setting the rollout percentage to 100 in all clusters whose labels match labels in the game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   CommitRolloutRequest request = CommitRolloutRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Operation> future = gameServerDeploymentsServiceClient.commitRolloutCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

revertRolloutAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> revertRolloutAsync(String name)

Rolls back the ongoing game server deployment rollout by setting the rollout percentage to 0 in all clusters whose labels match labels in the game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GameServerDeployment response = gameServerDeploymentsServiceClient.revertRolloutAsync(formattedName).get();
 }
 

Parameters:

name - Required. The name of the game server deployment to deploy, using the form:

`projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}`

Throws:

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

revertRolloutAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<GameServerDeployment,Empty> revertRolloutAsync(RevertRolloutRequest request)

Rolls back the ongoing game server deployment rollout by setting the rollout percentage to 0 in all clusters whose labels match labels in the game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   RevertRolloutRequest request = RevertRolloutRequest.newBuilder()
     .setName(formattedName)
     .build();
   GameServerDeployment response = gameServerDeploymentsServiceClient.revertRolloutAsync(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

revertRolloutOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<RevertRolloutRequest,GameServerDeployment,Empty> revertRolloutOperationCallable()

Rolls back the ongoing game server deployment rollout by setting the rollout percentage to 0 in all clusters whose labels match labels in the game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   RevertRolloutRequest request = RevertRolloutRequest.newBuilder()
     .setName(formattedName)
     .build();
   OperationFuture<GameServerDeployment, Empty> future = gameServerDeploymentsServiceClient.revertRolloutOperationCallable().futureCall(request);
   // Do something
   GameServerDeployment response = future.get();
 }
 

revertRolloutCallable

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

Rolls back the ongoing game server deployment rollout by setting the rollout percentage to 0 in all clusters whose labels match labels in the game server template.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   RevertRolloutRequest request = RevertRolloutRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Operation> future = gameServerDeploymentsServiceClient.revertRolloutCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getDeploymentTarget

public final DeploymentTarget getDeploymentTarget(String name)

Retrieves information on the rollout target of the deployment, e.g. the target percentage of game servers running stable_game_server_template and new_game_server_template in clusters.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   DeploymentTarget response = gameServerDeploymentsServiceClient.getDeploymentTarget(formattedName);
 }
 

Parameters:

name - Required. The name of the game server deployment, using the form:

`projects/{project_id}/locations/{location}/gameServerDeployments/{deployment_id}`

Throws:

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

getDeploymentTarget

public final DeploymentTarget getDeploymentTarget(GetDeploymentTargetRequest request)

Retrieves information on the rollout target of the deployment, e.g. the target percentage of game servers running stable_game_server_template and new_game_server_template in clusters.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GetDeploymentTargetRequest request = GetDeploymentTargetRequest.newBuilder()
     .setName(formattedName)
     .build();
   DeploymentTarget response = gameServerDeploymentsServiceClient.getDeploymentTarget(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

getDeploymentTargetCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDeploymentTargetRequest,DeploymentTarget> getDeploymentTargetCallable()

Retrieves information on the rollout target of the deployment, e.g. the target percentage of game servers running stable_game_server_template and new_game_server_template in clusters.

Sample code:

 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   String formattedName = GameServerDeploymentsServiceClient.formatGameServerDeploymentName("[PROJECT]", "[LOCATION]", "[GAME_SERVER_DEPLOYMENT]");
   GetDeploymentTargetRequest request = GetDeploymentTargetRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<DeploymentTarget> future = gameServerDeploymentsServiceClient.getDeploymentTargetCallable().futureCall(request);
   // Do something
   DeploymentTarget 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