GameServerClustersServiceClient (Google Cloud Game Services Parent 0.19.1 API)

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

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class GameServerClustersServiceClient
extends Object
implements BackgroundResource
```
Service Description: The game server cluster maps to Kubernetes clusters running Agones and is used to manage fleets within 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 (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedName = GameServerClustersServiceClient.formatGameServerClusterName("[PROJECT]", "[LOCATION]", "[REALM]", "[GAME_SERVER_CLUSTER]");
   GameServerCluster response = gameServerClustersServiceClient.getGameServerCluster(formattedName);
 }
 
 
```
Note: close() needs to be called on the gameServerClustersServiceClient 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 GameServerClustersServiceSettings to create(). For example:
To customize credentials:
```
 
 GameServerClustersServiceSettings gameServerClustersServiceSettings =
     GameServerClustersServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GameServerClustersServiceClient gameServerClustersServiceClient =
     GameServerClustersServiceClient.create(gameServerClustersServiceSettings);
 
 
```
To customize the endpoint:
```
 
 GameServerClustersServiceSettings gameServerClustersServiceSettings =
     GameServerClustersServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 GameServerClustersServiceClient gameServerClustersServiceClient =
     GameServerClustersServiceClient.create(gameServerClustersServiceSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GameServerClustersServiceClient.ListGameServerClustersFixedSizeCollection`
`static class`	`GameServerClustersServiceClient.ListGameServerClustersPage`
`static class`	`GameServerClustersServiceClient.ListGameServerClustersPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GameServerClustersServiceClient(GameServerClustersServiceSettings settings)` Constructs an instance of GameServerClustersServiceClient, using the given settings.
`protected`	`GameServerClustersServiceClient(GameServerClustersServiceStub 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 GameServerClustersServiceClient`	`create()` Constructs an instance of GameServerClustersServiceClient with default settings.
`static GameServerClustersServiceClient`	`create(GameServerClustersServiceSettings settings)` Constructs an instance of GameServerClustersServiceClient, using the given settings.
`static GameServerClustersServiceClient`	`create(GameServerClustersServiceStub stub)` Constructs an instance of GameServerClustersServiceClient, using the given stub for making calls.
`OperationFuture<GameServerCluster,Empty>`	`createGameServerClusterAsync(CreateGameServerClusterRequest request)` Creates a new game server cluster in a given project and location.
`OperationFuture<GameServerCluster,Empty>`	`createGameServerClusterAsync(String parent, String gameServerClusterId, GameServerCluster gameServerCluster)` Creates a new game server cluster in a given project and location.
`UnaryCallable<CreateGameServerClusterRequest,Operation>`	`createGameServerClusterCallable()` Creates a new game server cluster in a given project and location.
`OperationCallable<CreateGameServerClusterRequest,GameServerCluster,Empty>`	`createGameServerClusterOperationCallable()` Creates a new game server cluster in a given project and location.
`OperationFuture<Empty,Empty>`	`deleteGameServerClusterAsync(DeleteGameServerClusterRequest request)` Deletes a single game server cluster.
`OperationFuture<Empty,Empty>`	`deleteGameServerClusterAsync(String name)` Deletes a single game server cluster.
`UnaryCallable<DeleteGameServerClusterRequest,Operation>`	`deleteGameServerClusterCallable()` Deletes a single game server cluster.
`OperationCallable<DeleteGameServerClusterRequest,Empty,Empty>`	`deleteGameServerClusterOperationCallable()` Deletes a single game server cluster.
`static String`	`formatGameServerClusterName(String project, String location, String realm, String gameServerCluster)` Deprecated. Use the `GameServerClusterName` class instead.
`static String`	`formatRealmName(String project, String location, String realm)` Deprecated. Use the `RealmName` class instead.
`GameServerCluster`	`getGameServerCluster(GetGameServerClusterRequest request)` Gets details of a single game server cluster.
`GameServerCluster`	`getGameServerCluster(String name)` Gets details of a single game server cluster.
`UnaryCallable<GetGameServerClusterRequest,GameServerCluster>`	`getGameServerClusterCallable()` Gets details of a single game server cluster.
`OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`GameServerClustersServiceSettings`	`getSettings()`
`GameServerClustersServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`GameServerClustersServiceClient.ListGameServerClustersPagedResponse`	`listGameServerClusters(ListGameServerClustersRequest request)` Lists game server clusters in a given project and location.
`GameServerClustersServiceClient.ListGameServerClustersPagedResponse`	`listGameServerClusters(String parent)` Lists game server clusters in a given project and location.
`UnaryCallable<ListGameServerClustersRequest,ListGameServerClustersResponse>`	`listGameServerClustersCallable()` Lists game server clusters in a given project and location.
`UnaryCallable<ListGameServerClustersRequest,GameServerClustersServiceClient.ListGameServerClustersPagedResponse>`	`listGameServerClustersPagedCallable()` Lists game server clusters in a given project and location.
`static String`	`parseGameServerClusterFromGameServerClusterName(String gameServerClusterName)` Deprecated. Use the `GameServerClusterName` class instead.
`static String`	`parseLocationFromGameServerClusterName(String gameServerClusterName)` Deprecated. Use the `GameServerClusterName` class instead.
`static String`	`parseLocationFromRealmName(String realmName)` Deprecated. Use the `RealmName` class instead.
`static String`	`parseProjectFromGameServerClusterName(String gameServerClusterName)` Deprecated. Use the `GameServerClusterName` class instead.
`static String`	`parseProjectFromRealmName(String realmName)` Deprecated. Use the `RealmName` class instead.
`static String`	`parseRealmFromGameServerClusterName(String gameServerClusterName)` Deprecated. Use the `GameServerClusterName` class instead.
`static String`	`parseRealmFromRealmName(String realmName)` Deprecated. Use the `RealmName` class instead.
`PreviewCreateGameServerClusterResponse`	`previewCreateGameServerCluster(PreviewCreateGameServerClusterRequest request)` Previews creation of a new game server cluster in a given project and location.
`UnaryCallable<PreviewCreateGameServerClusterRequest,PreviewCreateGameServerClusterResponse>`	`previewCreateGameServerClusterCallable()` Previews creation of a new game server cluster in a given project and location.
`PreviewDeleteGameServerClusterResponse`	`previewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest request)` Previews deletion of a single game server cluster.
`UnaryCallable<PreviewDeleteGameServerClusterRequest,PreviewDeleteGameServerClusterResponse>`	`previewDeleteGameServerClusterCallable()` Previews deletion of a single game server cluster.
`PreviewUpdateGameServerClusterResponse`	`previewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest request)` Previews updating a GameServerCluster.
`UnaryCallable<PreviewUpdateGameServerClusterRequest,PreviewUpdateGameServerClusterResponse>`	`previewUpdateGameServerClusterCallable()` Previews updating a GameServerCluster.
`void`	`shutdown()`
`void`	`shutdownNow()`
`OperationFuture<GameServerCluster,Empty>`	`updateGameServerClusterAsync(GameServerCluster gameServerCluster, FieldMask updateMask)` Patches a single game server cluster.
`OperationFuture<GameServerCluster,Empty>`	`updateGameServerClusterAsync(UpdateGameServerClusterRequest request)` Patches a single game server cluster.
`UnaryCallable<UpdateGameServerClusterRequest,Operation>`	`updateGameServerClusterCallable()` Patches a single game server cluster.
`OperationCallable<UpdateGameServerClusterRequest,GameServerCluster,Empty>`	`updateGameServerClusterOperationCallable()` Patches a single game server cluster.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GameServerClustersServiceClient
```
protected GameServerClustersServiceClient(GameServerClustersServiceSettings settings)
                                   throws IOException
```
Constructs an instance of GameServerClustersServiceClient, 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

GameServerClustersServiceClient

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

Method Detail

formatGameServerClusterName

@Deprecated
public static final String formatGameServerClusterName(String project,
                                                                   String location,
                                                                   String realm,
                                                                   String gameServerCluster)

Deprecated. Use the GameServerClusterName class instead.

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

formatRealmName

@Deprecated
public static final String formatRealmName(String project,
                                                       String location,
                                                       String realm)

Deprecated. Use the RealmName class instead.

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

parseProjectFromGameServerClusterName
```
@Deprecated
public static final String parseProjectFromGameServerClusterName(String gameServerClusterName)
```
Deprecated. Use the GameServerClusterName class instead.

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

parseLocationFromGameServerClusterName
```
@Deprecated
public static final String parseLocationFromGameServerClusterName(String gameServerClusterName)
```
Deprecated. Use the GameServerClusterName class instead.

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

parseRealmFromGameServerClusterName
```
@Deprecated
public static final String parseRealmFromGameServerClusterName(String gameServerClusterName)
```
Deprecated. Use the GameServerClusterName class instead.

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

parseGameServerClusterFromGameServerClusterName
```
@Deprecated
public static final String parseGameServerClusterFromGameServerClusterName(String gameServerClusterName)
```
Deprecated. Use the GameServerClusterName class instead.

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

parseProjectFromRealmName
```
@Deprecated
public static final String parseProjectFromRealmName(String realmName)
```
Deprecated. Use the RealmName class instead.

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

parseLocationFromRealmName
```
@Deprecated
public static final String parseLocationFromRealmName(String realmName)
```
Deprecated. Use the RealmName class instead.

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

parseRealmFromRealmName
```
@Deprecated
public static final String parseRealmFromRealmName(String realmName)
```
Deprecated. Use the RealmName class instead.

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

create

public static final GameServerClustersServiceClient create()
                                                    throws IOException

Constructs an instance of GameServerClustersServiceClient with default settings.

Throws:: IOException

create
```
public static final GameServerClustersServiceClient create(GameServerClustersServiceSettings settings)
                                                    throws IOException
```
Constructs an instance of GameServerClustersServiceClient, 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 GameServerClustersServiceClient create(GameServerClustersServiceStub stub)

Constructs an instance of GameServerClustersServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use GameServerClustersServiceSettings}.

getSettings

public final GameServerClustersServiceSettings getSettings()

getStub

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

listGameServerClusters

public final GameServerClustersServiceClient.ListGameServerClustersPagedResponse listGameServerClusters(String parent)

Lists game server clusters in a given project and location.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedParent = GameServerClustersServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   for (GameServerCluster element : gameServerClustersServiceClient.listGameServerClusters(formattedParent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent resource name, using the form: "projects/{project}/locations/{location}/realms/{realm-id}".
Throws:: ApiException - if the remote call fails

listGameServerClusters

public final GameServerClustersServiceClient.ListGameServerClustersPagedResponse listGameServerClusters(ListGameServerClustersRequest request)

Lists game server clusters in a given project and location.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedParent = GameServerClustersServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   ListGameServerClustersRequest request = ListGameServerClustersRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (GameServerCluster element : gameServerClustersServiceClient.listGameServerClusters(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

listGameServerClustersPagedCallable

public final UnaryCallable<ListGameServerClustersRequest,GameServerClustersServiceClient.ListGameServerClustersPagedResponse> listGameServerClustersPagedCallable()

Lists game server clusters in a given project and location.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedParent = GameServerClustersServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   ListGameServerClustersRequest request = ListGameServerClustersRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListGameServerClustersPagedResponse> future = gameServerClustersServiceClient.listGameServerClustersPagedCallable().futureCall(request);
   // Do something
   for (GameServerCluster element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listGameServerClustersCallable

public final UnaryCallable<ListGameServerClustersRequest,ListGameServerClustersResponse> listGameServerClustersCallable()

Lists game server clusters in a given project and location.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedParent = GameServerClustersServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   ListGameServerClustersRequest request = ListGameServerClustersRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListGameServerClustersResponse response = gameServerClustersServiceClient.listGameServerClustersCallable().call(request);
     for (GameServerCluster element : response.getGameServerClustersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getGameServerCluster

public final GameServerCluster getGameServerCluster(String name)

Gets details of a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedName = GameServerClustersServiceClient.formatGameServerClusterName("[PROJECT]", "[LOCATION]", "[REALM]", "[GAME_SERVER_CLUSTER]");
   GameServerCluster response = gameServerClustersServiceClient.getGameServerCluster(formattedName);
 }

Parameters:: name - Required. The name of the game server cluster to retrieve, using the form:
`projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`
Throws:: ApiException - if the remote call fails

getGameServerCluster

public final GameServerCluster getGameServerCluster(GetGameServerClusterRequest request)

Gets details of a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedName = GameServerClustersServiceClient.formatGameServerClusterName("[PROJECT]", "[LOCATION]", "[REALM]", "[GAME_SERVER_CLUSTER]");
   GetGameServerClusterRequest request = GetGameServerClusterRequest.newBuilder()
     .setName(formattedName)
     .build();
   GameServerCluster response = gameServerClustersServiceClient.getGameServerCluster(request);
 }

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

getGameServerClusterCallable

public final UnaryCallable<GetGameServerClusterRequest,GameServerCluster> getGameServerClusterCallable()

Gets details of a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedName = GameServerClustersServiceClient.formatGameServerClusterName("[PROJECT]", "[LOCATION]", "[REALM]", "[GAME_SERVER_CLUSTER]");
   GetGameServerClusterRequest request = GetGameServerClusterRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<GameServerCluster> future = gameServerClustersServiceClient.getGameServerClusterCallable().futureCall(request);
   // Do something
   GameServerCluster response = future.get();
 }

createGameServerClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<GameServerCluster,Empty> createGameServerClusterAsync(String parent,
                                                                                                                                                                                             String gameServerClusterId,
                                                                                                                                                                                             GameServerCluster gameServerCluster)

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

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedParent = GameServerClustersServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   String gameServerClusterId = "";
   GameServerCluster gameServerCluster = GameServerCluster.newBuilder().build();
   GameServerCluster response = gameServerClustersServiceClient.createGameServerClusterAsync(formattedParent, gameServerClusterId, gameServerCluster).get();
 }

Parameters:: parent - Required. The parent resource name, using the form: `projects/{project}/locations/{location}/realms/{realm-id}`.; gameServerClusterId - Required. The ID of the game server cluster resource to be created.; gameServerCluster - Required. The game server cluster resource to be created.
Throws:: ApiException - if the remote call fails

createGameServerClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<GameServerCluster,Empty> createGameServerClusterAsync(CreateGameServerClusterRequest request)

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

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedParent = GameServerClustersServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   String gameServerClusterId = "";
   GameServerCluster gameServerCluster = GameServerCluster.newBuilder().build();
   CreateGameServerClusterRequest request = CreateGameServerClusterRequest.newBuilder()
     .setParent(formattedParent)
     .setGameServerClusterId(gameServerClusterId)
     .setGameServerCluster(gameServerCluster)
     .build();
   GameServerCluster response = gameServerClustersServiceClient.createGameServerClusterAsync(request).get();
 }

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

createGameServerClusterOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<CreateGameServerClusterRequest,GameServerCluster,Empty> createGameServerClusterOperationCallable()

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

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedParent = GameServerClustersServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   String gameServerClusterId = "";
   GameServerCluster gameServerCluster = GameServerCluster.newBuilder().build();
   CreateGameServerClusterRequest request = CreateGameServerClusterRequest.newBuilder()
     .setParent(formattedParent)
     .setGameServerClusterId(gameServerClusterId)
     .setGameServerCluster(gameServerCluster)
     .build();
   OperationFuture<GameServerCluster, Empty> future = gameServerClustersServiceClient.createGameServerClusterOperationCallable().futureCall(request);
   // Do something
   GameServerCluster response = future.get();
 }

createGameServerClusterCallable

public final UnaryCallable<CreateGameServerClusterRequest,Operation> createGameServerClusterCallable()

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

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedParent = GameServerClustersServiceClient.formatRealmName("[PROJECT]", "[LOCATION]", "[REALM]");
   String gameServerClusterId = "";
   GameServerCluster gameServerCluster = GameServerCluster.newBuilder().build();
   CreateGameServerClusterRequest request = CreateGameServerClusterRequest.newBuilder()
     .setParent(formattedParent)
     .setGameServerClusterId(gameServerClusterId)
     .setGameServerCluster(gameServerCluster)
     .build();
   ApiFuture<Operation> future = gameServerClustersServiceClient.createGameServerClusterCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

deleteGameServerClusterAsync

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

Deletes a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedName = GameServerClustersServiceClient.formatGameServerClusterName("[PROJECT]", "[LOCATION]", "[REALM]", "[GAME_SERVER_CLUSTER]");
   gameServerClustersServiceClient.deleteGameServerClusterAsync(formattedName).get();
 }

Parameters:: name - Required. The name of the game server cluster to delete, using the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`
Throws:: ApiException - if the remote call fails

deleteGameServerClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Empty> deleteGameServerClusterAsync(DeleteGameServerClusterRequest request)

Deletes a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedName = GameServerClustersServiceClient.formatGameServerClusterName("[PROJECT]", "[LOCATION]", "[REALM]", "[GAME_SERVER_CLUSTER]");
   DeleteGameServerClusterRequest request = DeleteGameServerClusterRequest.newBuilder()
     .setName(formattedName)
     .build();
   gameServerClustersServiceClient.deleteGameServerClusterAsync(request).get();
 }

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

deleteGameServerClusterOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<DeleteGameServerClusterRequest,Empty,Empty> deleteGameServerClusterOperationCallable()

Deletes a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedName = GameServerClustersServiceClient.formatGameServerClusterName("[PROJECT]", "[LOCATION]", "[REALM]", "[GAME_SERVER_CLUSTER]");
   DeleteGameServerClusterRequest request = DeleteGameServerClusterRequest.newBuilder()
     .setName(formattedName)
     .build();
   OperationFuture<Empty, Empty> future = gameServerClustersServiceClient.deleteGameServerClusterOperationCallable().futureCall(request);
   // Do something
   future.get();
 }

deleteGameServerClusterCallable

public final UnaryCallable<DeleteGameServerClusterRequest,Operation> deleteGameServerClusterCallable()

Deletes a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   String formattedName = GameServerClustersServiceClient.formatGameServerClusterName("[PROJECT]", "[LOCATION]", "[REALM]", "[GAME_SERVER_CLUSTER]");
   DeleteGameServerClusterRequest request = DeleteGameServerClusterRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Operation> future = gameServerClustersServiceClient.deleteGameServerClusterCallable().futureCall(request);
   // Do something
   future.get();
 }

updateGameServerClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<GameServerCluster,Empty> updateGameServerClusterAsync(GameServerCluster gameServerCluster,
                                                                                                                                                                                             FieldMask updateMask)

Patches a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   GameServerCluster gameServerCluster = GameServerCluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   GameServerCluster response = gameServerClustersServiceClient.updateGameServerClusterAsync(gameServerCluster, updateMask).get();
 }

Parameters:: gameServerCluster - Required. The game server cluster 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

updateGameServerClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<GameServerCluster,Empty> updateGameServerClusterAsync(UpdateGameServerClusterRequest request)

Patches a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   GameServerCluster gameServerCluster = GameServerCluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateGameServerClusterRequest request = UpdateGameServerClusterRequest.newBuilder()
     .setGameServerCluster(gameServerCluster)
     .setUpdateMask(updateMask)
     .build();
   GameServerCluster response = gameServerClustersServiceClient.updateGameServerClusterAsync(request).get();
 }

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

updateGameServerClusterOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<UpdateGameServerClusterRequest,GameServerCluster,Empty> updateGameServerClusterOperationCallable()

Patches a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   GameServerCluster gameServerCluster = GameServerCluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateGameServerClusterRequest request = UpdateGameServerClusterRequest.newBuilder()
     .setGameServerCluster(gameServerCluster)
     .setUpdateMask(updateMask)
     .build();
   OperationFuture<GameServerCluster, Empty> future = gameServerClustersServiceClient.updateGameServerClusterOperationCallable().futureCall(request);
   // Do something
   GameServerCluster response = future.get();
 }

updateGameServerClusterCallable

public final UnaryCallable<UpdateGameServerClusterRequest,Operation> updateGameServerClusterCallable()

Patches a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   GameServerCluster gameServerCluster = GameServerCluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateGameServerClusterRequest request = UpdateGameServerClusterRequest.newBuilder()
     .setGameServerCluster(gameServerCluster)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<Operation> future = gameServerClustersServiceClient.updateGameServerClusterCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

previewCreateGameServerCluster

public final PreviewCreateGameServerClusterResponse previewCreateGameServerCluster(PreviewCreateGameServerClusterRequest request)

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

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   PreviewCreateGameServerClusterRequest request = PreviewCreateGameServerClusterRequest.newBuilder().build();
   PreviewCreateGameServerClusterResponse response = gameServerClustersServiceClient.previewCreateGameServerCluster(request);
 }

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

previewCreateGameServerClusterCallable

public final UnaryCallable<PreviewCreateGameServerClusterRequest,PreviewCreateGameServerClusterResponse> previewCreateGameServerClusterCallable()

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

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   PreviewCreateGameServerClusterRequest request = PreviewCreateGameServerClusterRequest.newBuilder().build();
   ApiFuture<PreviewCreateGameServerClusterResponse> future = gameServerClustersServiceClient.previewCreateGameServerClusterCallable().futureCall(request);
   // Do something
   PreviewCreateGameServerClusterResponse response = future.get();
 }

previewDeleteGameServerCluster

public final PreviewDeleteGameServerClusterResponse previewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest request)

Previews deletion of a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   PreviewDeleteGameServerClusterRequest request = PreviewDeleteGameServerClusterRequest.newBuilder().build();
   PreviewDeleteGameServerClusterResponse response = gameServerClustersServiceClient.previewDeleteGameServerCluster(request);
 }

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

previewDeleteGameServerClusterCallable

public final UnaryCallable<PreviewDeleteGameServerClusterRequest,PreviewDeleteGameServerClusterResponse> previewDeleteGameServerClusterCallable()

Previews deletion of a single game server cluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   PreviewDeleteGameServerClusterRequest request = PreviewDeleteGameServerClusterRequest.newBuilder().build();
   ApiFuture<PreviewDeleteGameServerClusterResponse> future = gameServerClustersServiceClient.previewDeleteGameServerClusterCallable().futureCall(request);
   // Do something
   PreviewDeleteGameServerClusterResponse response = future.get();
 }

previewUpdateGameServerCluster

public final PreviewUpdateGameServerClusterResponse previewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest request)

Previews updating a GameServerCluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   PreviewUpdateGameServerClusterRequest request = PreviewUpdateGameServerClusterRequest.newBuilder().build();
   PreviewUpdateGameServerClusterResponse response = gameServerClustersServiceClient.previewUpdateGameServerCluster(request);
 }

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

previewUpdateGameServerClusterCallable

public final UnaryCallable<PreviewUpdateGameServerClusterRequest,PreviewUpdateGameServerClusterResponse> previewUpdateGameServerClusterCallable()

Previews updating a GameServerCluster.

Sample code:


 try (GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.create()) {
   PreviewUpdateGameServerClusterRequest request = PreviewUpdateGameServerClusterRequest.newBuilder().build();
   ApiFuture<PreviewUpdateGameServerClusterResponse> future = gameServerClustersServiceClient.previewUpdateGameServerClusterCallable().futureCall(request);
   // Do something
   PreviewUpdateGameServerClusterResponse 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 GameServerClustersServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GameServerClustersServiceClient

GameServerClustersServiceClient

Method Detail

formatGameServerClusterName

formatRealmName

parseProjectFromGameServerClusterName

parseLocationFromGameServerClusterName

parseRealmFromGameServerClusterName

parseGameServerClusterFromGameServerClusterName

parseProjectFromRealmName

parseLocationFromRealmName

parseRealmFromRealmName

create

create

create

getSettings

getStub

getOperationsClient

listGameServerClusters

listGameServerClusters

listGameServerClustersPagedCallable

listGameServerClustersCallable

getGameServerCluster

getGameServerCluster

getGameServerClusterCallable

createGameServerClusterAsync

createGameServerClusterAsync

createGameServerClusterOperationCallable

createGameServerClusterCallable

deleteGameServerClusterAsync

deleteGameServerClusterAsync

deleteGameServerClusterOperationCallable

deleteGameServerClusterCallable

updateGameServerClusterAsync

updateGameServerClusterAsync

updateGameServerClusterOperationCallable

updateGameServerClusterCallable

previewCreateGameServerCluster

previewCreateGameServerClusterCallable

previewDeleteGameServerCluster

previewDeleteGameServerClusterCallable

previewUpdateGameServerCluster

previewUpdateGameServerClusterCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination