com.google.cloud.gaming.v1beta

Class GameServerConfigsServiceClient

java.lang.Object

com.google.cloud.gaming.v1beta.GameServerConfigsServiceClient

All Implemented Interfaces:

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

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

Service Description: The game server config configures the game servers in an Agones fleet.

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

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

Note: close() needs to be called on the GameServerConfigsServiceClient 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 GameServerConfigsServiceSettings to create(). For example:

To customize credentials:

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

To customize the endpoint:

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

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

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GameServerConfigsServiceClient.ListGameServerConfigsFixedSizeCollection
static class	GameServerConfigsServiceClient.ListGameServerConfigsPage
static class	GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GameServerConfigsServiceClient(GameServerConfigsServiceSettings settings) Constructs an instance of GameServerConfigsServiceClient, using the given settings.
protected	GameServerConfigsServiceClient(GameServerConfigsServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static GameServerConfigsServiceClient	create() Constructs an instance of GameServerConfigsServiceClient with default settings.
static GameServerConfigsServiceClient	create(GameServerConfigsServiceSettings settings) Constructs an instance of GameServerConfigsServiceClient, using the given settings.
static GameServerConfigsServiceClient	create(GameServerConfigsServiceStub stub) Constructs an instance of GameServerConfigsServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<GameServerConfig,OperationMetadata>	createGameServerConfigAsync(CreateGameServerConfigRequest request) Creates a new game server config in a given project, location, and game server deployment.
com.google.api.gax.longrunning.OperationFuture<GameServerConfig,OperationMetadata>	createGameServerConfigAsync(GameServerDeploymentName parent, GameServerConfig gameServerConfig) Creates a new game server config in a given project, location, and game server deployment.
com.google.api.gax.longrunning.OperationFuture<GameServerConfig,OperationMetadata>	createGameServerConfigAsync(String parent, GameServerConfig gameServerConfig) Creates a new game server config in a given project, location, and game server deployment.
com.google.api.gax.rpc.UnaryCallable<CreateGameServerConfigRequest,com.google.longrunning.Operation>	createGameServerConfigCallable() Creates a new game server config in a given project, location, and game server deployment.
com.google.api.gax.rpc.OperationCallable<CreateGameServerConfigRequest,GameServerConfig,OperationMetadata>	createGameServerConfigOperationCallable() Creates a new game server config in a given project, location, and game server deployment.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteGameServerConfigAsync(DeleteGameServerConfigRequest request) Deletes a single game server config.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteGameServerConfigAsync(GameServerConfigName name) Deletes a single game server config.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteGameServerConfigAsync(String name) Deletes a single game server config.
com.google.api.gax.rpc.UnaryCallable<DeleteGameServerConfigRequest,com.google.longrunning.Operation>	deleteGameServerConfigCallable() Deletes a single game server config.
com.google.api.gax.rpc.OperationCallable<DeleteGameServerConfigRequest,com.google.protobuf.Empty,OperationMetadata>	deleteGameServerConfigOperationCallable() Deletes a single game server config.
GameServerConfig	getGameServerConfig(GameServerConfigName name) Gets details of a single game server config.
GameServerConfig	getGameServerConfig(GetGameServerConfigRequest request) Gets details of a single game server config.
GameServerConfig	getGameServerConfig(String name) Gets details of a single game server config.
com.google.api.gax.rpc.UnaryCallable<GetGameServerConfigRequest,GameServerConfig>	getGameServerConfigCallable() Gets details of a single game server config.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
GameServerConfigsServiceSettings	getSettings()
GameServerConfigsServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse	listGameServerConfigs(GameServerDeploymentName parent) Lists game server configs in a given project, location, and game server deployment.
GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse	listGameServerConfigs(ListGameServerConfigsRequest request) Lists game server configs in a given project, location, and game server deployment.
GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse	listGameServerConfigs(String parent) Lists game server configs in a given project, location, and game server deployment.
com.google.api.gax.rpc.UnaryCallable<ListGameServerConfigsRequest,ListGameServerConfigsResponse>	listGameServerConfigsCallable() Lists game server configs in a given project, location, and game server deployment.
com.google.api.gax.rpc.UnaryCallable<ListGameServerConfigsRequest,GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse>	listGameServerConfigsPagedCallable() Lists game server configs in a given project, location, and game server deployment.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

GameServerConfigsServiceClient

protected GameServerConfigsServiceClient(GameServerConfigsServiceSettings settings)
                                  throws IOException

Constructs an instance of GameServerConfigsServiceClient, 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

GameServerConfigsServiceClient

protected GameServerConfigsServiceClient(GameServerConfigsServiceStub stub)

Method Detail

create

public static final GameServerConfigsServiceClient create()
                                                   throws IOException

Constructs an instance of GameServerConfigsServiceClient with default settings.

Throws:

IOException

create

public static final GameServerConfigsServiceClient create(GameServerConfigsServiceSettings settings)
                                                   throws IOException

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

Throws:

IOException

create

public static final GameServerConfigsServiceClient create(GameServerConfigsServiceStub stub)

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

getSettings

public final GameServerConfigsServiceSettings getSettings()

getStub

public GameServerConfigsServiceStub getStub()

getOperationsClient

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

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

getHttpJsonOperationsClient

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

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

listGameServerConfigs

public final GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse listGameServerConfigs(GameServerDeploymentName parent)

Lists game server configs in a given project, location, and game server deployment.

Sample code:

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

Parameters:

parent - Required. The parent resource name. Uses the form:

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

Throws:

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

listGameServerConfigs

public final GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse listGameServerConfigs(String parent)

Lists game server configs in a given project, location, and game server deployment.

Sample code:

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

Parameters:

parent - Required. The parent resource name. Uses the form:

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

Throws:

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

listGameServerConfigs

public final GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse listGameServerConfigs(ListGameServerConfigsRequest request)

Lists game server configs in a given project, location, and game server deployment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerConfigsServiceClient gameServerConfigsServiceClient =
     GameServerConfigsServiceClient.create()) {
   ListGameServerConfigsRequest request =
       ListGameServerConfigsRequest.newBuilder()
           .setParent(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (GameServerConfig element :
       gameServerConfigsServiceClient.listGameServerConfigs(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

listGameServerConfigsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGameServerConfigsRequest,GameServerConfigsServiceClient.ListGameServerConfigsPagedResponse> listGameServerConfigsPagedCallable()

Lists game server configs in a given project, location, and game server deployment.

Sample code:

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

listGameServerConfigsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGameServerConfigsRequest,ListGameServerConfigsResponse> listGameServerConfigsCallable()

Lists game server configs in a given project, location, and game server deployment.

Sample code:

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

getGameServerConfig

public final GameServerConfig getGameServerConfig(GameServerConfigName name)

Gets details of a single game server config.

Sample code:

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

Parameters:

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

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

Throws:

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

getGameServerConfig

public final GameServerConfig getGameServerConfig(String name)

Gets details of a single game server config.

Sample code:

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

Parameters:

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

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

Throws:

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

getGameServerConfig

public final GameServerConfig getGameServerConfig(GetGameServerConfigRequest request)

Gets details of a single game server config.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerConfigsServiceClient gameServerConfigsServiceClient =
     GameServerConfigsServiceClient.create()) {
   GetGameServerConfigRequest request =
       GetGameServerConfigRequest.newBuilder()
           .setName(
               GameServerConfigName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]")
                   .toString())
           .build();
   GameServerConfig response = gameServerConfigsServiceClient.getGameServerConfig(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

getGameServerConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<GetGameServerConfigRequest,GameServerConfig> getGameServerConfigCallable()

Gets details of a single game server config.

Sample code:

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

createGameServerConfigAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerConfig,OperationMetadata> createGameServerConfigAsync(GameServerDeploymentName parent,
                                                                                                                            GameServerConfig gameServerConfig)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Sample code:

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

Parameters:

parent - Required. The parent resource name. Uses the form:

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

gameServerConfig - Required. The game server config resource to be created.

Throws:

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

createGameServerConfigAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerConfig,OperationMetadata> createGameServerConfigAsync(String parent,
                                                                                                                            GameServerConfig gameServerConfig)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Sample code:

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

Parameters:

parent - Required. The parent resource name. Uses the form:

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

gameServerConfig - Required. The game server config resource to be created.

Throws:

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

createGameServerConfigAsync

public final com.google.api.gax.longrunning.OperationFuture<GameServerConfig,OperationMetadata> createGameServerConfigAsync(CreateGameServerConfigRequest request)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerConfigsServiceClient gameServerConfigsServiceClient =
     GameServerConfigsServiceClient.create()) {
   CreateGameServerConfigRequest request =
       CreateGameServerConfigRequest.newBuilder()
           .setParent(
               GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]").toString())
           .setConfigId("configId-580140035")
           .setGameServerConfig(GameServerConfig.newBuilder().build())
           .build();
   GameServerConfig response =
       gameServerConfigsServiceClient.createGameServerConfigAsync(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

createGameServerConfigOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateGameServerConfigRequest,GameServerConfig,OperationMetadata> createGameServerConfigOperationCallable()

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Sample code:

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

createGameServerConfigCallable

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

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Sample code:

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

deleteGameServerConfigAsync

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Sample code:

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

Parameters:

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

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

Throws:

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

deleteGameServerConfigAsync

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Sample code:

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

Parameters:

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

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

Throws:

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

deleteGameServerConfigAsync

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GameServerConfigsServiceClient gameServerConfigsServiceClient =
     GameServerConfigsServiceClient.create()) {
   DeleteGameServerConfigRequest request =
       DeleteGameServerConfigRequest.newBuilder()
           .setName(
               GameServerConfigName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]")
                   .toString())
           .build();
   gameServerConfigsServiceClient.deleteGameServerConfigAsync(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

deleteGameServerConfigOperationCallable

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Sample code:

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

deleteGameServerConfigCallable

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Sample code:

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