Interface InstanceAdminClient (6.58.0)

public interface InstanceAdminClient

Client to do admin operations on Cloud Spanner Instance and Instance Configs.

Methods

cancelOperation(String name)

public abstract void cancelOperation(String name)

Cancels the specified long-running operation.

Parameter
Name	Description
`name`	`String`

createInstance(InstanceInfo instance)

public abstract OperationFuture<Instance,CreateInstanceMetadata> createInstance(InstanceInfo instance)

Creates an instance and begins preparing it to begin serving. The returned Operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, a SpannerException is thrown. Immediately upon completion of this request:

The instance is readable via the API, with all requested attributes but no allocated resources.
Its state is CREATING.

Until completion of the returned operation:

Cancelling the operation renders the instance immediately unreadable via the API.
The instance can be deleted.
All other attempts to modify the instance are rejected.

Upon completion of the returned operation:

Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
Databases can be created in the instance.
The instance's allocated resource levels are readable via the


 final String instanceId = my_instance_id;
 final String configId = my_config_id;
 final String clientProject = my_client_project;

 Operation<Instance, CreateInstanceMetadata> op =
     instanceAdminClient.createInstance(InstanceInfo
         .newBuilder(InstanceId.of(clientProject, instanceId))
         .setInstanceConfigId(InstanceConfigId.of(clientProject, configId))
         .setDisplayName(instanceId)
         .setNodeCount(1)
         .build());
 op.waitFor();

Parameter
Name	Description
`instance`	`InstanceInfo`

Returns
Type	Description
`OperationFuture<Instance,CreateInstanceMetadata>`

Exceptions
Type	Description
`SpannerException`

createInstanceConfig(InstanceConfigInfo instanceConfig, Options.CreateAdminApiOption[] options)

public default OperationFuture<InstanceConfig,CreateInstanceConfigMetadata> createInstanceConfig(InstanceConfigInfo instanceConfig, Options.CreateAdminApiOption[] options)

Creates an instance config and begins preparing it to be used. The returned Operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller and must start with the string 'custom'. If the named instance config already exists, a SpannerException is thrown.

Immediately after the request returns:

The instance config is readable via the API, with all requested attributes.
The instance config's reconciling field is set to true. Its state is CREATING.

While the operation is pending:

Cancelling the operation renders the instance config immediately unreadable via the API.
Except for deleting the creating resource, all other attempts to modify the instance config are rejected.

Upon completion of the returned operation:

Instances can be created using the instance configuration.
The instance config's reconciling field becomes false.
Its state becomes READY.


 String projectId = "my-project";
 String baseInstanceConfig = "my-base-config";
 String instanceConfigId = "custom-user-config";

 final InstanceConfig baseConfig = instanceAdminClient.getInstanceConfig(baseInstanceConfig);

 List<ReplicaInfo> readOnlyReplicas = ImmutableList.of(baseConfig.getOptionalReplicas().get(0));

 InstanceConfigInfo instanceConfigInfo =
     InstanceConfigInfo.newBuilder(InstanceConfigId.of(projectId, instanceConfigId), baseConfig)
         .setDisplayName(instanceConfigId)
         .addReadOnlyReplicas(readOnlyReplicas)
         .build();

 final OperationFuture<InstanceConfig, CreateInstanceConfigMetadata> operation =
     instanceAdminClient.createInstanceConfig(instanceConfigInfo);

 InstanceConfig instanceConfig = op.get(5, TimeUnit.MINUTES)

Parameters
Name	Description
`instanceConfig`	`InstanceConfigInfo`
`options`	`CreateAdminApiOption[]`

Returns
Type	Description
`OperationFuture<InstanceConfig,CreateInstanceConfigMetadata>`

Exceptions
Type	Description
`SpannerException`

deleteInstance(String instanceId)

public abstract void deleteInstance(String instanceId)

Deletes an instance.

Parameter
Name	Description
`instanceId`	`String`

Exceptions
Type	Description
`SpannerException`

deleteInstanceConfig(String instanceConfigId, Options.DeleteAdminApiOption[] options)

public default void deleteInstanceConfig(String instanceConfigId, Options.DeleteAdminApiOption[] options)

Deletes a custom instance config. Deletion is only allowed for custom instance configs and when no instances are using the configuration. If any instances are using the config, a SpannerException is thrown.

Only user managed configurations can be deleted.


 String projectId = "my-project";
 String instanceConfigId = "custom-user-config";

 instanceAdminClient.deleteInstanceConfig(instanceConfigId);

Parameters
Name	Description
`instanceConfigId`	`String`
`options`	`DeleteAdminApiOption[]`

Exceptions
Type	Description
`SpannerException`

getInstance(String instanceId)

public abstract Instance getInstance(String instanceId)

Gets an instance.

Parameter
Name	Description
`instanceId`	`String`

Returns
Type	Description
`Instance`

Exceptions
Type	Description
`SpannerException`

getInstanceConfig(String configId)

public abstract InstanceConfig getInstanceConfig(String configId)

Gets an instance config.

Parameter
Name	Description
`configId`	`String`

Returns
Type	Description
`InstanceConfig`

Exceptions
Type	Description
`SpannerException`

getInstanceIAMPolicy(String instanceId)

public abstract Policy getInstanceIAMPolicy(String instanceId)

Returns the IAM policy for the given instance.

Parameter
Name	Description
`instanceId`	`String`

Returns
Type	Description
`com.google.cloud.Policy`

getOperation(String name)

public abstract Operation getOperation(String name)

Gets the specified long-running operation.

Parameter
Name	Description
`name`	`String`

Returns
Type	Description
`Operation`

listInstanceConfigOperations(Options.ListOption[] options)

public default Page<Operation> listInstanceConfigOperations(Options.ListOption[] options)

Lists long-running instance config operations.

Parameter
Name	Description
`options`	`ListOption[]`

Returns
Type	Description
`Page<Operation>`

listInstanceConfigs(Options.ListOption[] options)

public abstract Page<InstanceConfig> listInstanceConfigs(Options.ListOption[] options)

Lists the supported instance configs for current project.

Parameter
Name	Description
`options`	`ListOption[]`

Returns
Type	Description
`Page<InstanceConfig>`

Exceptions
Type	Description
`SpannerException`

listInstances(Options.ListOption[] options)

public abstract Page<Instance> listInstances(Options.ListOption[] options)

Lists the instances.

Parameter

Name Description

options

ListOption[]

Options to control the instances returned. It also supports Options#filter(String) option. The fields eligible for filtering are:

name
display_name
labels.key where key is the name of a label


 List<Instance> instances =
     Lists.newArrayList(
         instanceAdminClient.listInstances(Options.pageSize(1)).iterateAll());

 <!--SNIPPET instance_admin_client_list_instances-->

Returns
Type	Description
`Page<Instance>`

Exceptions
Type	Description
`SpannerException`

newInstanceBuilder(InstanceId id)

public abstract Instance.Builder newInstanceBuilder(InstanceId id)

Returns a builder for Instance object with the given id.

Parameter
Name	Description
`id`	`InstanceId`

Returns
Type	Description
`Instance.Builder`

setInstanceIAMPolicy(String instanceId, Policy policy)

public abstract Policy setInstanceIAMPolicy(String instanceId, Policy policy)

Updates the IAM policy for the given instance and returns the resulting policy. It is highly recommended to first get the current policy and base the updated policy on the returned policy. See Policy.Builder#setEtag(String) for information on the recommended read-modify-write cycle.

Parameters
Name	Description
`instanceId`	`String`
`policy`	`com.google.cloud.Policy`

Returns
Type	Description
`com.google.cloud.Policy`

testInstanceIAMPermissions(String instanceId, Iterable<String> permissions)

public abstract Iterable<String> testInstanceIAMPermissions(String instanceId, Iterable<String> permissions)

Tests for the given permissions on the specified instance for the caller.

Parameters
Name	Description
`instanceId`	`String` the id of the instance to test.
`permissions`	`Iterable<String>` the permissions to test for. Permissions with wildcards (such as '', 'spanner.', 'spanner.instances.*') are not allowed.

Returns
Type	Description
`Iterable<String>`	the subset of the tested permissions that the caller is allowed.

updateInstance(InstanceInfo instance, InstanceInfo.InstanceField[] fieldsToUpdate)

public abstract OperationFuture<Instance,UpdateInstanceMetadata> updateInstance(InstanceInfo instance, InstanceInfo.InstanceField[] fieldsToUpdate)

Updates an instance, and begins allocating or releasing resources as requested. The returned Operation can be used to track the progress of updating the instance. If the named instance does not exist, throws SpannerException.

Immediately upon completion of this request:

For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level.

Until completion of the returned operation:

Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a CANCELLED status.
All other attempts to modify the instance are rejected.
Reading the instance via the API continues to give the pre-request resource levels.

Upon completion of the returned operation:

Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
All newly-reserved resources are available for serving the instance's tables.
The instance's new resource levels are readable via the API.


 Instance instance = my_instance;
 final String clientProject = my_client_project;
 final String instanceId = my_instance_id;

 final String newDisplayName = my_display_name;

 InstanceInfo toUpdate =
     InstanceInfo.newBuilder(InstanceId.of(clientProject, instanceId))
         .setDisplayName(newDisplayName)
         .setNodeCount(instance.getNodeCount() + 1)
         .build();
 // Only update display name
 Operation<Instance, UpdateInstanceMetadata> op =
     instanceAdminClient.updateInstance(toUpdate, InstanceInfo.InstanceField.DISPLAY_NAME);
 op.waitFor().getResult();

Parameters
Name	Description
`instance`	`InstanceInfo`
`fieldsToUpdate`	`InstanceField[]`

Returns
Type	Description
`OperationFuture<Instance,UpdateInstanceMetadata>`

updateInstanceConfig(InstanceConfigInfo instanceConfig, Iterable<InstanceConfigInfo.InstanceConfigField> fieldsToUpdate, Options.UpdateAdminApiOption[] options)

public default OperationFuture<InstanceConfig,UpdateInstanceConfigMetadata> updateInstanceConfig(InstanceConfigInfo instanceConfig, Iterable<InstanceConfigInfo.InstanceConfigField> fieldsToUpdate, Options.UpdateAdminApiOption[] options)

Updates a custom instance config. This can not be used to update a Google managed instance config. The returned Operation can be used to track the progress of updating the instance. If the named instance config does not exist, a SpannerException is thrown. The request must include at least one field to update.

Only user managed configurations can be updated.

Immediately after the request returns:

The instance config's reconciling field is set to true.

While the operation is pending:

Cancelling the operation sets its metadata's cancel_time.
The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a CANCELLED status.
All other attempts to modify the instance config are rejected.
Reading the instance config via the API continues to give the pre-request values.

Upon completion of the returned operation:

Creating instances using the instance configuration uses the new values.
The instance config's new values are readable via the API.
The instance config's reconciling field becomes false.


 String projectId = "my-project";
 String instanceConfigId = "custom-user-config";
 String displayName = "my-display-name";

 InstanceConfigInfo instanceConfigInfo =
     InstanceConfigInfo.newBuilder(InstanceConfigId.of(projectId, instanceConfigId))
         .setDisplayName(displayName)
         .build();

 // Only update display name.
 final OperationFuture<InstanceConfig, UpdateInstanceConfigMetadata> operation =
     instanceAdminClient.updateInstanceConfig(
         instanceConfigInfo, ImmutableList.of(InstanceConfigField.DISPLAY_NAME));

 InstanceConfig instanceConfig = operation.get(5, TimeUnit.MINUTES);

Parameters
Name	Description
`instanceConfig`	`InstanceConfigInfo`
`fieldsToUpdate`	`Iterable<InstanceConfigField>`
`options`	`UpdateAdminApiOption[]`

Returns
Type	Description
`OperationFuture<InstanceConfig,UpdateInstanceConfigMetadata>`

Exceptions
Type	Description
`SpannerException`