GameServerDeploymentsServiceClient (Google Cloud Game Services Parent 0.19.1 API)

java.lang.Object
- com.google.cloud.gaming.v1alpha.GameServerDeploymentsServiceClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class GameServerDeploymentsServiceClient
extends Object
implements BackgroundResource
```
Service Description: The game server deployment is used to control the deployment of game server software to 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:
```
 
 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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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.
`OperationFuture<GameServerDeployment,Empty>`	`createGameServerDeploymentAsync(CreateGameServerDeploymentRequest request)` Creates a new game server deployment in a given project and location.
`OperationFuture<GameServerDeployment,Empty>`	`createGameServerDeploymentAsync(String parent, String deploymentId, GameServerDeployment gameServerDeployment)` Creates a new game server deployment in a given project and location.
`UnaryCallable<CreateGameServerDeploymentRequest,Operation>`	`createGameServerDeploymentCallable()` Creates a new game server deployment in a given project and location.
`OperationCallable<CreateGameServerDeploymentRequest,GameServerDeployment,Empty>`	`createGameServerDeploymentOperationCallable()` Creates a new game server deployment in a given project and location.
`OperationFuture<Empty,Empty>`	`deleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest request)` Deletes a single game server deployment.
`OperationFuture<Empty,Empty>`	`deleteGameServerDeploymentAsync(String name)` Deletes a single game server deployment.
`UnaryCallable<DeleteGameServerDeploymentRequest,Operation>`	`deleteGameServerDeploymentCallable()` Deletes a single game server deployment.
`OperationCallable<DeleteGameServerDeploymentRequest,Empty,Empty>`	`deleteGameServerDeploymentOperationCallable()` Deletes a single game server deployment.
`FetchDeploymentStateResponse`	`fetchDeploymentState(FetchDeploymentStateRequest request)` Retrieves information about the current state of the deployment, e.g.
`UnaryCallable<FetchDeploymentStateRequest,FetchDeploymentStateResponse>`	`fetchDeploymentStateCallable()` Retrieves information about the current state of the deployment, e.g.
`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.
`GameServerDeployment`	`getGameServerDeployment(GetGameServerDeploymentRequest request)` Gets details of a single game server deployment.
`GameServerDeployment`	`getGameServerDeployment(String name)` Gets details of a single game server deployment.
`UnaryCallable<GetGameServerDeploymentRequest,GameServerDeployment>`	`getGameServerDeploymentCallable()` Gets details of a single game server deployment.
`GameServerDeploymentRollout`	`getGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest request)` Gets details a single game server deployment rollout.
`UnaryCallable<GetGameServerDeploymentRolloutRequest,GameServerDeploymentRollout>`	`getGameServerDeploymentRolloutCallable()` Gets details a single game server deployment rollout.
`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.
`UnaryCallable<ListGameServerDeploymentsRequest,ListGameServerDeploymentsResponse>`	`listGameServerDeploymentsCallable()` Lists game server deployments in a given project and location.
`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.
`PreviewGameServerDeploymentRolloutResponse`	`previewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest request)` Previews the game server deployment rollout.
`UnaryCallable<PreviewGameServerDeploymentRolloutRequest,PreviewGameServerDeploymentRolloutResponse>`	`previewGameServerDeploymentRolloutCallable()` Previews the game server deployment rollout.
`void`	`shutdown()`
`void`	`shutdownNow()`
`OperationFuture<GameServerDeployment,Empty>`	`updateGameServerDeploymentAsync(GameServerDeployment gameServerDeployment, FieldMask updateMask)` Patches a game server deployment.
`OperationFuture<GameServerDeployment,Empty>`	`updateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest request)` Patches a game server deployment.
`UnaryCallable<UpdateGameServerDeploymentRequest,Operation>`	`updateGameServerDeploymentCallable()` Patches a game server deployment.
`OperationCallable<UpdateGameServerDeploymentRequest,GameServerDeployment,Empty>`	`updateGameServerDeploymentOperationCallable()` Patches a game server deployment.
`Operation`	`updateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest request)` Patches a single game server deployment rollout.
`UnaryCallable<UpdateGameServerDeploymentRolloutRequest,Operation>`	`updateGameServerDeploymentRolloutCallable()` 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

@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 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}/locations/{location}`.
Throws:: 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:: ApiException - if the remote call fails

listGameServerDeploymentsPagedCallable

public final 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 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}/locations/{location}/gameServerDeployments/{deployment}`
Throws:: 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:: ApiException - if the remote call fails

getGameServerDeploymentCallable

public final 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 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}/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:: 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 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:: 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 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 UnaryCallable<CreateGameServerDeploymentRequest,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 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}/locations/{location}/gameServerDeployments/{deployment}`
Throws:: 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 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:: 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 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 UnaryCallable<DeleteGameServerDeploymentRequest,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 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:: 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 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:: 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 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 UnaryCallable<UpdateGameServerDeploymentRequest,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();
 }

getGameServerDeploymentRollout

public final GameServerDeploymentRollout getGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest request)

Gets details a single game server deployment rollout.

Sample code:


 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   GetGameServerDeploymentRolloutRequest request = GetGameServerDeploymentRolloutRequest.newBuilder().build();
   GameServerDeploymentRollout response = gameServerDeploymentsServiceClient.getGameServerDeploymentRollout(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getGameServerDeploymentRolloutCallable

public final UnaryCallable<GetGameServerDeploymentRolloutRequest,GameServerDeploymentRollout> getGameServerDeploymentRolloutCallable()

Gets details a single game server deployment rollout.

Sample code:


 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   GetGameServerDeploymentRolloutRequest request = GetGameServerDeploymentRolloutRequest.newBuilder().build();
   ApiFuture<GameServerDeploymentRollout> future = gameServerDeploymentsServiceClient.getGameServerDeploymentRolloutCallable().futureCall(request);
   // Do something
   GameServerDeploymentRollout response = future.get();
 }

updateGameServerDeploymentRollout

public final Operation updateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest request)

Patches a single game server deployment rollout.

Sample code:


 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   UpdateGameServerDeploymentRolloutRequest request = UpdateGameServerDeploymentRolloutRequest.newBuilder().build();
   Operation response = gameServerDeploymentsServiceClient.updateGameServerDeploymentRollout(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

updateGameServerDeploymentRolloutCallable

public final UnaryCallable<UpdateGameServerDeploymentRolloutRequest,Operation> updateGameServerDeploymentRolloutCallable()

Patches a single game server deployment rollout.

Sample code:


 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   UpdateGameServerDeploymentRolloutRequest request = UpdateGameServerDeploymentRolloutRequest.newBuilder().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:


 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   PreviewGameServerDeploymentRolloutRequest request = PreviewGameServerDeploymentRolloutRequest.newBuilder().build();
   PreviewGameServerDeploymentRolloutResponse response = gameServerDeploymentsServiceClient.previewGameServerDeploymentRollout(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

previewGameServerDeploymentRolloutCallable

public final UnaryCallable<PreviewGameServerDeploymentRolloutRequest,PreviewGameServerDeploymentRolloutResponse> previewGameServerDeploymentRolloutCallable()

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

Sample code:


 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   PreviewGameServerDeploymentRolloutRequest request = PreviewGameServerDeploymentRolloutRequest.newBuilder().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 deployment, e.g. it gathers all the fleets and autoscalars for this deployment. This includes fleets running older version of the deployment.

Sample code:


 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   FetchDeploymentStateRequest request = FetchDeploymentStateRequest.newBuilder().build();
   FetchDeploymentStateResponse response = gameServerDeploymentsServiceClient.fetchDeploymentState(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

fetchDeploymentStateCallable

public final UnaryCallable<FetchDeploymentStateRequest,FetchDeploymentStateResponse> fetchDeploymentStateCallable()

Retrieves information about the current state of the deployment, e.g. it gathers all the fleets and autoscalars for this deployment. This includes fleets running older version of the deployment.

Sample code:


 try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.create()) {
   FetchDeploymentStateRequest request = FetchDeploymentStateRequest.newBuilder().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 BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class GameServerDeploymentsServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GameServerDeploymentsServiceClient

GameServerDeploymentsServiceClient

Method Detail

formatGameServerDeploymentName

formatLocationName

parseProjectFromGameServerDeploymentName

parseLocationFromGameServerDeploymentName

parseGameServerDeploymentFromGameServerDeploymentName

parseProjectFromLocationName

parseLocationFromLocationName

create

create

create

getSettings

getStub

getOperationsClient

listGameServerDeployments

listGameServerDeployments

listGameServerDeploymentsPagedCallable

listGameServerDeploymentsCallable

getGameServerDeployment

getGameServerDeployment

getGameServerDeploymentCallable

createGameServerDeploymentAsync

createGameServerDeploymentAsync

createGameServerDeploymentOperationCallable

createGameServerDeploymentCallable

deleteGameServerDeploymentAsync

deleteGameServerDeploymentAsync

deleteGameServerDeploymentOperationCallable

deleteGameServerDeploymentCallable

updateGameServerDeploymentAsync

updateGameServerDeploymentAsync

updateGameServerDeploymentOperationCallable

updateGameServerDeploymentCallable

getGameServerDeploymentRollout

getGameServerDeploymentRolloutCallable

updateGameServerDeploymentRollout

updateGameServerDeploymentRolloutCallable

previewGameServerDeploymentRollout

previewGameServerDeploymentRolloutCallable

fetchDeploymentState

fetchDeploymentStateCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination