Package com.google.cloud.spanner.admin.instance.v1

The interfaces provided are listed below, along with usage samples.

InstanceAdminClient

Service Description: Cloud Spanner Instance Admin API

The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.

Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.

Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

Sample for InstanceAdminClient:


 try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
   InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
   InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
 }

Classes

InstanceAdminClient

Service Description: Cloud Spanner Instance Admin API

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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
   InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
   InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
 }

Note: close() needs to be called on the InstanceAdminClient 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:

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.
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.
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 InstanceAdminSettings to create(). For example:

To customize credentials:


 InstanceAdminSettings instanceAdminSettings =
     InstanceAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InstanceAdminClient instanceAdminClient = InstanceAdminClient.create(instanceAdminSettings);

To customize the endpoint:


 InstanceAdminSettings instanceAdminSettings =
     InstanceAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 InstanceAdminClient instanceAdminClient = InstanceAdminClient.create(instanceAdminSettings);

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

The default service address (spanner.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getInstanceConfig to 30 seconds:


 InstanceAdminSettings.Builder instanceAdminSettingsBuilder = InstanceAdminSettings.newBuilder();
 instanceAdminSettingsBuilder
     .getInstanceConfigSettings()
     .setRetrySettings(
         instanceAdminSettingsBuilder
             .getInstanceConfigSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 InstanceAdminSettings instanceAdminSettings = instanceAdminSettingsBuilder.build();

InstanceAdminSettings.Builder

Builder for InstanceAdminSettings.

Package com.google.cloud.spanner.admin.instance.v1

InstanceAdminClient

Classes

InstanceAdminClient

InstanceAdminClient.ListInstanceConfigsFixedSizeCollection

InstanceAdminClient.ListInstanceConfigsPage

InstanceAdminClient.ListInstanceConfigsPagedResponse

InstanceAdminClient.ListInstancesFixedSizeCollection

InstanceAdminClient.ListInstancesPage

InstanceAdminClient.ListInstancesPagedResponse

InstanceAdminSettings

InstanceAdminSettings.Builder