com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient Maven / Gradle / Ivy
Show all versions of google-cloud-spanner Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.spanner.admin.instance.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.resourcenames.ResourceName;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import com.google.spanner.admin.instance.v1.CreateInstanceConfigMetadata;
import com.google.spanner.admin.instance.v1.CreateInstanceConfigRequest;
import com.google.spanner.admin.instance.v1.CreateInstanceMetadata;
import com.google.spanner.admin.instance.v1.CreateInstancePartitionMetadata;
import com.google.spanner.admin.instance.v1.CreateInstancePartitionRequest;
import com.google.spanner.admin.instance.v1.CreateInstanceRequest;
import com.google.spanner.admin.instance.v1.DeleteInstanceConfigRequest;
import com.google.spanner.admin.instance.v1.DeleteInstancePartitionRequest;
import com.google.spanner.admin.instance.v1.DeleteInstanceRequest;
import com.google.spanner.admin.instance.v1.GetInstanceConfigRequest;
import com.google.spanner.admin.instance.v1.GetInstancePartitionRequest;
import com.google.spanner.admin.instance.v1.GetInstanceRequest;
import com.google.spanner.admin.instance.v1.Instance;
import com.google.spanner.admin.instance.v1.InstanceConfig;
import com.google.spanner.admin.instance.v1.InstanceConfigName;
import com.google.spanner.admin.instance.v1.InstanceName;
import com.google.spanner.admin.instance.v1.InstancePartition;
import com.google.spanner.admin.instance.v1.InstancePartitionName;
import com.google.spanner.admin.instance.v1.ListInstanceConfigOperationsRequest;
import com.google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse;
import com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest;
import com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse;
import com.google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest;
import com.google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse;
import com.google.spanner.admin.instance.v1.ListInstancePartitionsRequest;
import com.google.spanner.admin.instance.v1.ListInstancePartitionsResponse;
import com.google.spanner.admin.instance.v1.ListInstancesRequest;
import com.google.spanner.admin.instance.v1.ListInstancesResponse;
import com.google.spanner.admin.instance.v1.MoveInstanceMetadata;
import com.google.spanner.admin.instance.v1.MoveInstanceRequest;
import com.google.spanner.admin.instance.v1.MoveInstanceResponse;
import com.google.spanner.admin.instance.v1.ProjectName;
import com.google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata;
import com.google.spanner.admin.instance.v1.UpdateInstanceConfigRequest;
import com.google.spanner.admin.instance.v1.UpdateInstanceMetadata;
import com.google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata;
import com.google.spanner.admin.instance.v1.UpdateInstancePartitionRequest;
import com.google.spanner.admin.instance.v1.UpdateInstanceRequest;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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.
*
*
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:
*
*
{@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 (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().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* ListInstanceConfigs
Lists the supported instance configurations for a given project.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listInstanceConfigs(ListInstanceConfigsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listInstanceConfigs(ProjectName parent)
*
listInstanceConfigs(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listInstanceConfigsPagedCallable()
*
listInstanceConfigsCallable()
*
*
*
*
* GetInstanceConfig
Gets information about a particular instance configuration.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getInstanceConfig(GetInstanceConfigRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getInstanceConfig(InstanceConfigName name)
*
getInstanceConfig(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getInstanceConfigCallable()
*
*
*
*
* CreateInstanceConfig
Creates an instance configuration and begins preparing it to be used. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`.
*
Immediately after the request returns:
*
* The instance configuration is readable via the API, with all requested attributes. The instance configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to true. Its state is `CREATING`.
*
While the operation is pending:
*
* Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected.
*
Upon completion of the returned operation:
*
* Instances can be created using the instance configuration. * The instance configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field becomes false. Its state becomes `READY`.
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<instance_config_name>/operations/<operation_id>` and can be used to track creation of the instance configuration. The [metadata][google.longrunning.Operation.metadata] field type is [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata]. The [response][google.longrunning.Operation.response] field type is [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
Authorization requires `spanner.instanceConfigs.create` permission on the resource [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createInstanceConfigAsync(CreateInstanceConfigRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* createInstanceConfigAsync(ProjectName parent, InstanceConfig instanceConfig, String instanceConfigId)
*
createInstanceConfigAsync(String parent, InstanceConfig instanceConfig, String instanceConfigId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createInstanceConfigOperationCallable()
*
createInstanceConfigCallable()
*
*
*
*
* UpdateInstanceConfig
Updates an instance configuration. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`.
*
Only user-managed configurations can be updated.
*
Immediately after the request returns:
*
* The instance configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to true.
*
While the operation is pending:
*
* Cancelling the operation sets its metadata's [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.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 configuration are rejected. * Reading the instance configuration 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 new values of the instance configuration are readable via the API. * The instance configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field becomes false.
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<instance_config_name>/operations/<operation_id>` and can be used to track the instance configuration modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata]. The [response][google.longrunning.Operation.response] field type is [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
Authorization requires `spanner.instanceConfigs.update` permission on the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateInstanceConfigAsync(UpdateInstanceConfigRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* updateInstanceConfigAsync(InstanceConfig instanceConfig, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateInstanceConfigOperationCallable()
*
updateInstanceConfigCallable()
*
*
*
*
* DeleteInstanceConfig
Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`.
*
Only user-managed configurations can be deleted.
*
Authorization requires `spanner.instanceConfigs.delete` permission on the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteInstanceConfig(DeleteInstanceConfigRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteInstanceConfig(InstanceConfigName name)
*
deleteInstanceConfig(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteInstanceConfigCallable()
*
*
*
*
* ListInstanceConfigOperations
Lists the user-managed instance configuration [long-running operations][google.longrunning.Operation] in the given project. An instance configuration operation has a name of the form `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listInstanceConfigOperations(ListInstanceConfigOperationsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listInstanceConfigOperations(ProjectName parent)
*
listInstanceConfigOperations(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listInstanceConfigOperationsPagedCallable()
*
listInstanceConfigOperationsCallable()
*
*
*
*
* ListInstances
Lists all instances in the given project.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listInstances(ListInstancesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listInstances(ProjectName parent)
*
listInstances(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listInstancesPagedCallable()
*
listInstancesCallable()
*
*
*
*
* ListInstancePartitions
Lists all instance partitions for the given instance.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listInstancePartitions(ListInstancePartitionsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listInstancePartitions(InstanceName parent)
*
listInstancePartitions(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listInstancePartitionsPagedCallable()
*
listInstancePartitionsCallable()
*
*
*
*
* GetInstance
Gets information about a particular instance.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getInstance(GetInstanceRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getInstance(InstanceName name)
*
getInstance(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getInstanceCallable()
*
*
*
*
* CreateInstance
Creates an instance and begins preparing it to begin serving. The returned [long-running operation][google.longrunning.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, `CreateInstance` returns `ALREADY_EXISTS`.
*
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 API. * The instance's state becomes `READY`.
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createInstanceAsync(CreateInstanceRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* createInstanceAsync(ProjectName parent, String instanceId, Instance instance)
*
createInstanceAsync(String parent, String instanceId, Instance instance)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createInstanceOperationCallable()
*
createInstanceCallable()
*
*
*
*
* UpdateInstance
Updates an instance, and begins allocating or releasing resources as requested. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`.
*
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][google.spanner.admin.instance.v1.UpdateInstanceMetadata.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.
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track the instance modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
Authorization requires `spanner.instances.update` permission on the resource [name][google.spanner.admin.instance.v1.Instance.name].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateInstanceAsync(UpdateInstanceRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* updateInstanceAsync(Instance instance, FieldMask fieldMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateInstanceOperationCallable()
*
updateInstanceCallable()
*
*
*
*
* DeleteInstance
Deletes an instance.
*
Immediately upon completion of the request:
*
* Billing ceases for all of the instance's reserved resources.
*
Soon afterward:
*
* The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteInstance(DeleteInstanceRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteInstance(InstanceName name)
*
deleteInstance(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteInstanceCallable()
*
*
*
*
* SetIamPolicy
Sets the access control policy on an instance resource. Replaces any existing policy.
*
Authorization requires `spanner.instances.setIamPolicy` on [resource][google.iam.v1.SetIamPolicyRequest.resource].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* setIamPolicy(SetIamPolicyRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* setIamPolicy(ResourceName resource, Policy policy)
*
setIamPolicy(String resource, Policy policy)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* setIamPolicyCallable()
*
*
*
*
* GetIamPolicy
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
*
Authorization requires `spanner.instances.getIamPolicy` on [resource][google.iam.v1.GetIamPolicyRequest.resource].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getIamPolicy(GetIamPolicyRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getIamPolicy(ResourceName resource)
*
getIamPolicy(String resource)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getIamPolicyCallable()
*
*
*
*
* TestIamPermissions
Returns permissions that the caller has on the specified instance resource.
*
Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* testIamPermissions(TestIamPermissionsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* testIamPermissions(ResourceName resource, List<String> permissions)
*
testIamPermissions(String resource, List<String> permissions)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* testIamPermissionsCallable()
*
*
*
*
* GetInstancePartition
Gets information about a particular instance partition.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getInstancePartition(GetInstancePartitionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getInstancePartition(InstancePartitionName name)
*
getInstancePartition(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getInstancePartitionCallable()
*
*
*
*
* CreateInstancePartition
Creates an instance partition and begins preparing it to be used. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of preparing the new instance partition. The instance partition name is assigned by the caller. If the named instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`.
*
Immediately upon completion of this request:
*
* The instance partition 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 partition immediately unreadable via the API. * The instance partition can be deleted. * All other attempts to modify the instance partition 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 start using this instance partition. * The instance partition's allocated resource levels are readable via the API. * The instance partition's state becomes `READY`.
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<instance_partition_name>/operations/<operation_id>` and can be used to track creation of the instance partition. The [metadata][google.longrunning.Operation.metadata] field type is [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata]. The [response][google.longrunning.Operation.response] field type is [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createInstancePartitionAsync(CreateInstancePartitionRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* createInstancePartitionAsync(InstanceName parent, InstancePartition instancePartition, String instancePartitionId)
*
createInstancePartitionAsync(String parent, InstancePartition instancePartition, String instancePartitionId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createInstancePartitionOperationCallable()
*
createInstancePartitionCallable()
*
*
*
*
* DeleteInstancePartition
Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance.
*
Authorization requires `spanner.instancePartitions.delete` permission on the resource [name][google.spanner.admin.instance.v1.InstancePartition.name].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteInstancePartition(DeleteInstancePartitionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteInstancePartition(InstancePartitionName name)
*
deleteInstancePartition(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteInstancePartitionCallable()
*
*
*
*
* UpdateInstancePartition
Updates an instance partition, and begins allocating or releasing resources as requested. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance partition. If the named instance partition does not exist, returns `NOT_FOUND`.
*
Immediately upon completion of this request:
*
* For resource types for which a decrease in the instance partition'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][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata.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 partition are rejected. * Reading the instance partition 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 partition's tables. * The instance partition's new resource levels are readable via the API.
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<instance_partition_name>/operations/<operation_id>` and can be used to track the instance partition modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata]. The [response][google.longrunning.Operation.response] field type is [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
Authorization requires `spanner.instancePartitions.update` permission on the resource [name][google.spanner.admin.instance.v1.InstancePartition.name].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateInstancePartitionAsync(UpdateInstancePartitionRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* updateInstancePartitionAsync(InstancePartition instancePartition, FieldMask fieldMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateInstancePartitionOperationCallable()
*
updateInstancePartitionCallable()
*
*
*
*
* ListInstancePartitionOperations
Lists instance partition [long-running operations][google.longrunning.Operation] in the given instance. An instance partition operation has a name of the form `projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.
*
Authorization requires `spanner.instancePartitionOperations.list` permission on the resource [parent][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.parent].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listInstancePartitionOperations(ListInstancePartitionOperationsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listInstancePartitionOperations(InstanceName parent)
*
listInstancePartitionOperations(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listInstancePartitionOperationsPagedCallable()
*
listInstancePartitionOperationsCallable()
*
*
*
*
* MoveInstance
Moves an instance to the target instance configuration. You can use the returned [long-running operation][google.longrunning.Operation] to track the progress of moving the instance.
*
`MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria:
*
* Is undergoing a move to a different instance configuration * Has backups * Has an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance
*
While the operation is pending:
*
* All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected:
*
* `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` * `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup`
*
* Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance might experience higher read-write latencies and a higher transaction abort rate. However, moving an instance doesn't cause any downtime.
*
The returned [long-running operation][google.longrunning.Operation] has a name of the format `<instance_name>/operations/<operation_id>` and can be used to track the move instance operation. The [metadata][google.longrunning.Operation.metadata] field type is [MoveInstanceMetadata][google.spanner.admin.instance.v1.MoveInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful. Cancelling the operation sets its metadata's [cancel_time][google.spanner.admin.instance.v1.MoveInstanceMetadata.cancel_time]. Cancellation is not immediate because it involves moving any data previously moved to the target instance configuration back to the original instance configuration. You can use this operation to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status.
*
If not cancelled, upon completion of the returned operation:
*
* The instance successfully moves to the target instance configuration. * You are billed for compute and storage in target instance configuration.
*
Authorization requires the `spanner.instances.update` permission on the resource [instance][google.spanner.admin.instance.v1.Instance].
*
For more details, see [Move an instance](https://cloud.google.com/spanner/docs/move-instance).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* moveInstanceAsync(MoveInstanceRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* moveInstanceOperationCallable()
*
moveInstanceCallable()
*
*
*
*
*
* 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:
*
*
{@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
* InstanceAdminSettings instanceAdminSettings =
* InstanceAdminSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* InstanceAdminClient instanceAdminClient = InstanceAdminClient.create(instanceAdminSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* InstanceAdminSettings instanceAdminSettings =
* InstanceAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
* InstanceAdminClient instanceAdminClient = InstanceAdminClient.create(instanceAdminSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* InstanceAdminSettings instanceAdminSettings =
* InstanceAdminSettings.newHttpJsonBuilder().build();
* InstanceAdminClient instanceAdminClient = InstanceAdminClient.create(instanceAdminSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class InstanceAdminClient implements BackgroundResource {
private final InstanceAdminSettings settings;
private final InstanceAdminStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of InstanceAdminClient with default settings. */
public static final InstanceAdminClient create() throws IOException {
return create(InstanceAdminSettings.newBuilder().build());
}
/**
* Constructs an instance of InstanceAdminClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final InstanceAdminClient create(InstanceAdminSettings settings)
throws IOException {
return new InstanceAdminClient(settings);
}
/**
* Constructs an instance of InstanceAdminClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(InstanceAdminSettings).
*/
public static final InstanceAdminClient create(InstanceAdminStub stub) {
return new InstanceAdminClient(stub);
}
/**
* Constructs an instance of InstanceAdminClient, 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.
*/
protected InstanceAdminClient(InstanceAdminSettings settings) throws IOException {
this.settings = settings;
this.stub = ((InstanceAdminStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected InstanceAdminClient(InstanceAdminStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final InstanceAdminSettings getSettings() {
return settings;
}
public InstanceAdminStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the supported instance configurations for a given project.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The name of the project for which a list of supported instance
* configurations is requested. Values are of the form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstanceConfigsPagedResponse listInstanceConfigs(ProjectName parent) {
ListInstanceConfigsRequest request =
ListInstanceConfigsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listInstanceConfigs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the supported instance configurations for a given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The name of the project for which a list of supported instance
* configurations is requested. Values are of the form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstanceConfigsPagedResponse listInstanceConfigs(String parent) {
ListInstanceConfigsRequest request =
ListInstanceConfigsRequest.newBuilder().setParent(parent).build();
return listInstanceConfigs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the supported instance configurations for a given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstanceConfigsRequest request =
* ListInstanceConfigsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListInstanceConfigsPagedResponse listInstanceConfigs(
ListInstanceConfigsRequest request) {
return listInstanceConfigsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the supported instance configurations for a given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstanceConfigsRequest request =
* ListInstanceConfigsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* instanceAdminClient.listInstanceConfigsPagedCallable().futureCall(request);
* // Do something.
* for (InstanceConfig element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listInstanceConfigsPagedCallable() {
return stub.listInstanceConfigsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the supported instance configurations for a given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstanceConfigsRequest request =
* ListInstanceConfigsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListInstanceConfigsResponse response =
* instanceAdminClient.listInstanceConfigsCallable().call(request);
* for (InstanceConfig element : response.getInstanceConfigsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listInstanceConfigsCallable() {
return stub.listInstanceConfigsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance configuration.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
* InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
* }
* }
*
* @param name Required. The name of the requested instance configuration. Values are of the form
* `projects/<project>/instanceConfigs/<config>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final InstanceConfig getInstanceConfig(InstanceConfigName name) {
GetInstanceConfigRequest request =
GetInstanceConfigRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getInstanceConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance configuration.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString();
* InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
* }
* }
*
* @param name Required. The name of the requested instance configuration. Values are of the form
* `projects/<project>/instanceConfigs/<config>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final InstanceConfig getInstanceConfig(String name) {
GetInstanceConfigRequest request = GetInstanceConfigRequest.newBuilder().setName(name).build();
return getInstanceConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance configuration.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* GetInstanceConfigRequest request =
* GetInstanceConfigRequest.newBuilder()
* .setName(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
* .build();
* InstanceConfig response = instanceAdminClient.getInstanceConfig(request);
* }
* }
*
* @param 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
*/
public final InstanceConfig getInstanceConfig(GetInstanceConfigRequest request) {
return getInstanceConfigCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance configuration.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* GetInstanceConfigRequest request =
* GetInstanceConfigRequest.newBuilder()
* .setName(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
* .build();
* ApiFuture future =
* instanceAdminClient.getInstanceConfigCallable().futureCall(request);
* // Do something.
* InstanceConfig response = future.get();
* }
* }
*/
public final UnaryCallable getInstanceConfigCallable() {
return stub.getInstanceConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance configuration and begins preparing it to be used. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* preparing the new instance configuration. The instance configuration name is assigned by the
* caller. If the named instance configuration already exists, `CreateInstanceConfig` returns
* `ALREADY_EXISTS`.
*
* Immediately after the request returns:
*
*
* The instance configuration is readable via the API, with all requested attributes. The
* instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true. Its state is `CREATING`.
*
*
While the operation is pending:
*
*
* Cancelling the operation renders the instance configuration immediately unreadable via
* the API. * Except for deleting the creating resource, all other attempts to modify the
* instance configuration are rejected.
*
*
Upon completion of the returned operation:
*
*
* Instances can be created using the instance configuration. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false. Its state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* creation of the instance configuration. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.create` permission on the resource
* [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* InstanceConfig instanceConfig = InstanceConfig.newBuilder().build();
* String instanceConfigId = "instanceConfigId1750947762";
* InstanceConfig response =
* instanceAdminClient
* .createInstanceConfigAsync(parent, instanceConfig, instanceConfigId)
* .get();
* }
* }
*
* @param parent Required. The name of the project in which to create the instance configuration.
* Values are of the form `projects/<project>`.
* @param instanceConfig Required. The InstanceConfig proto of the configuration to create.
* instance_config.name must be `<parent>/instanceConfigs/<instance_config_id>`.
* instance_config.base_config must be a Google managed configuration name, e.g.
* <parent>/instanceConfigs/us-east1, <parent>/instanceConfigs/nam3.
* @param instanceConfigId Required. The ID of the instance configuration to create. Valid
* identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64
* characters in length. The `custom-` prefix is required to avoid name conflicts with
* Google-managed configurations.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
createInstanceConfigAsync(
ProjectName parent, InstanceConfig instanceConfig, String instanceConfigId) {
CreateInstanceConfigRequest request =
CreateInstanceConfigRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setInstanceConfig(instanceConfig)
.setInstanceConfigId(instanceConfigId)
.build();
return createInstanceConfigAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance configuration and begins preparing it to be used. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* preparing the new instance configuration. The instance configuration name is assigned by the
* caller. If the named instance configuration already exists, `CreateInstanceConfig` returns
* `ALREADY_EXISTS`.
*
* Immediately after the request returns:
*
*
* The instance configuration is readable via the API, with all requested attributes. The
* instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true. Its state is `CREATING`.
*
*
While the operation is pending:
*
*
* Cancelling the operation renders the instance configuration immediately unreadable via
* the API. * Except for deleting the creating resource, all other attempts to modify the
* instance configuration are rejected.
*
*
Upon completion of the returned operation:
*
*
* Instances can be created using the instance configuration. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false. Its state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* creation of the instance configuration. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.create` permission on the resource
* [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* InstanceConfig instanceConfig = InstanceConfig.newBuilder().build();
* String instanceConfigId = "instanceConfigId1750947762";
* InstanceConfig response =
* instanceAdminClient
* .createInstanceConfigAsync(parent, instanceConfig, instanceConfigId)
* .get();
* }
* }
*
* @param parent Required. The name of the project in which to create the instance configuration.
* Values are of the form `projects/<project>`.
* @param instanceConfig Required. The InstanceConfig proto of the configuration to create.
* instance_config.name must be `<parent>/instanceConfigs/<instance_config_id>`.
* instance_config.base_config must be a Google managed configuration name, e.g.
* <parent>/instanceConfigs/us-east1, <parent>/instanceConfigs/nam3.
* @param instanceConfigId Required. The ID of the instance configuration to create. Valid
* identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64
* characters in length. The `custom-` prefix is required to avoid name conflicts with
* Google-managed configurations.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
createInstanceConfigAsync(
String parent, InstanceConfig instanceConfig, String instanceConfigId) {
CreateInstanceConfigRequest request =
CreateInstanceConfigRequest.newBuilder()
.setParent(parent)
.setInstanceConfig(instanceConfig)
.setInstanceConfigId(instanceConfigId)
.build();
return createInstanceConfigAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance configuration and begins preparing it to be used. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* preparing the new instance configuration. The instance configuration name is assigned by the
* caller. If the named instance configuration already exists, `CreateInstanceConfig` returns
* `ALREADY_EXISTS`.
*
* Immediately after the request returns:
*
*
* The instance configuration is readable via the API, with all requested attributes. The
* instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true. Its state is `CREATING`.
*
*
While the operation is pending:
*
*
* Cancelling the operation renders the instance configuration immediately unreadable via
* the API. * Except for deleting the creating resource, all other attempts to modify the
* instance configuration are rejected.
*
*
Upon completion of the returned operation:
*
*
* Instances can be created using the instance configuration. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false. Its state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* creation of the instance configuration. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.create` permission on the resource
* [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstanceConfigRequest request =
* CreateInstanceConfigRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setInstanceConfigId("instanceConfigId1750947762")
* .setInstanceConfig(InstanceConfig.newBuilder().build())
* .setValidateOnly(true)
* .build();
* InstanceConfig response = instanceAdminClient.createInstanceConfigAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture
createInstanceConfigAsync(CreateInstanceConfigRequest request) {
return createInstanceConfigOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance configuration and begins preparing it to be used. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* preparing the new instance configuration. The instance configuration name is assigned by the
* caller. If the named instance configuration already exists, `CreateInstanceConfig` returns
* `ALREADY_EXISTS`.
*
* Immediately after the request returns:
*
*
* The instance configuration is readable via the API, with all requested attributes. The
* instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true. Its state is `CREATING`.
*
*
While the operation is pending:
*
*
* Cancelling the operation renders the instance configuration immediately unreadable via
* the API. * Except for deleting the creating resource, all other attempts to modify the
* instance configuration are rejected.
*
*
Upon completion of the returned operation:
*
*
* Instances can be created using the instance configuration. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false. Its state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* creation of the instance configuration. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.create` permission on the resource
* [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstanceConfigRequest request =
* CreateInstanceConfigRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setInstanceConfigId("instanceConfigId1750947762")
* .setInstanceConfig(InstanceConfig.newBuilder().build())
* .setValidateOnly(true)
* .build();
* OperationFuture future =
* instanceAdminClient.createInstanceConfigOperationCallable().futureCall(request);
* // Do something.
* InstanceConfig response = future.get();
* }
* }
*/
public final OperationCallable<
CreateInstanceConfigRequest, InstanceConfig, CreateInstanceConfigMetadata>
createInstanceConfigOperationCallable() {
return stub.createInstanceConfigOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance configuration and begins preparing it to be used. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* preparing the new instance configuration. The instance configuration name is assigned by the
* caller. If the named instance configuration already exists, `CreateInstanceConfig` returns
* `ALREADY_EXISTS`.
*
* Immediately after the request returns:
*
*
* The instance configuration is readable via the API, with all requested attributes. The
* instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true. Its state is `CREATING`.
*
*
While the operation is pending:
*
*
* Cancelling the operation renders the instance configuration immediately unreadable via
* the API. * Except for deleting the creating resource, all other attempts to modify the
* instance configuration are rejected.
*
*
Upon completion of the returned operation:
*
*
* Instances can be created using the instance configuration. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false. Its state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* creation of the instance configuration. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.create` permission on the resource
* [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstanceConfigRequest request =
* CreateInstanceConfigRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setInstanceConfigId("instanceConfigId1750947762")
* .setInstanceConfig(InstanceConfig.newBuilder().build())
* .setValidateOnly(true)
* .build();
* ApiFuture future =
* instanceAdminClient.createInstanceConfigCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
createInstanceConfigCallable() {
return stub.createInstanceConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance configuration. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of updating the
* instance. If the named instance configuration does not exist, returns `NOT_FOUND`.
*
* Only user-managed configurations can be updated.
*
*
Immediately after the request returns:
*
*
* The instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true.
*
*
While the operation is pending:
*
*
* Cancelling the operation sets its metadata's
* [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.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 configuration are
* rejected. * Reading the instance configuration 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 new
* values of the instance configuration are readable via the API. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* the instance configuration modification. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.update` permission on the resource
* [name][google.spanner.admin.instance.v1.InstanceConfig.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstanceConfig instanceConfig = InstanceConfig.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* InstanceConfig response =
* instanceAdminClient.updateInstanceConfigAsync(instanceConfig, updateMask).get();
* }
* }
*
* @param instanceConfig Required. The user instance configuration to update, which must always
* include the instance configuration name. Otherwise, only fields mentioned in
* [update_mask][google.spanner.admin.instance.v1.UpdateInstanceConfigRequest.update_mask]
* need be included. To prevent conflicts of concurrent updates,
* [etag][google.spanner.admin.instance.v1.InstanceConfig.reconciling] can be used.
* @param updateMask Required. A mask specifying which fields in
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] should be updated. The
* field mask must always be specified; this prevents any future fields in
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] from being erased
* accidentally by clients that do not know about them. Only display_name and labels can be
* updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
updateInstanceConfigAsync(InstanceConfig instanceConfig, FieldMask updateMask) {
UpdateInstanceConfigRequest request =
UpdateInstanceConfigRequest.newBuilder()
.setInstanceConfig(instanceConfig)
.setUpdateMask(updateMask)
.build();
return updateInstanceConfigAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance configuration. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of updating the
* instance. If the named instance configuration does not exist, returns `NOT_FOUND`.
*
* Only user-managed configurations can be updated.
*
*
Immediately after the request returns:
*
*
* The instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true.
*
*
While the operation is pending:
*
*
* Cancelling the operation sets its metadata's
* [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.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 configuration are
* rejected. * Reading the instance configuration 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 new
* values of the instance configuration are readable via the API. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* the instance configuration modification. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.update` permission on the resource
* [name][google.spanner.admin.instance.v1.InstanceConfig.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstanceConfigRequest request =
* UpdateInstanceConfigRequest.newBuilder()
* .setInstanceConfig(InstanceConfig.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .setValidateOnly(true)
* .build();
* InstanceConfig response = instanceAdminClient.updateInstanceConfigAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture
updateInstanceConfigAsync(UpdateInstanceConfigRequest request) {
return updateInstanceConfigOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance configuration. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of updating the
* instance. If the named instance configuration does not exist, returns `NOT_FOUND`.
*
* Only user-managed configurations can be updated.
*
*
Immediately after the request returns:
*
*
* The instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true.
*
*
While the operation is pending:
*
*
* Cancelling the operation sets its metadata's
* [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.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 configuration are
* rejected. * Reading the instance configuration 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 new
* values of the instance configuration are readable via the API. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* the instance configuration modification. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.update` permission on the resource
* [name][google.spanner.admin.instance.v1.InstanceConfig.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstanceConfigRequest request =
* UpdateInstanceConfigRequest.newBuilder()
* .setInstanceConfig(InstanceConfig.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .setValidateOnly(true)
* .build();
* OperationFuture future =
* instanceAdminClient.updateInstanceConfigOperationCallable().futureCall(request);
* // Do something.
* InstanceConfig response = future.get();
* }
* }
*/
public final OperationCallable<
UpdateInstanceConfigRequest, InstanceConfig, UpdateInstanceConfigMetadata>
updateInstanceConfigOperationCallable() {
return stub.updateInstanceConfigOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance configuration. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of updating the
* instance. If the named instance configuration does not exist, returns `NOT_FOUND`.
*
* Only user-managed configurations can be updated.
*
*
Immediately after the request returns:
*
*
* The instance configuration's
* [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling] field is set to
* true.
*
*
While the operation is pending:
*
*
* Cancelling the operation sets its metadata's
* [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.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 configuration are
* rejected. * Reading the instance configuration 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 new
* values of the instance configuration are readable via the API. * The instance
* configuration's [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
* field becomes false.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_config_name>/operations/<operation_id>` and can be used to track
* the instance configuration modification. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if successful.
*
*
Authorization requires `spanner.instanceConfigs.update` permission on the resource
* [name][google.spanner.admin.instance.v1.InstanceConfig.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstanceConfigRequest request =
* UpdateInstanceConfigRequest.newBuilder()
* .setInstanceConfig(InstanceConfig.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .setValidateOnly(true)
* .build();
* ApiFuture future =
* instanceAdminClient.updateInstanceConfigCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
updateInstanceConfigCallable() {
return stub.updateInstanceConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the instance configuration. Deletion is only allowed when no instances are using the
* configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`.
*
* Only user-managed configurations can be deleted.
*
*
Authorization requires `spanner.instanceConfigs.delete` permission on the resource
* [name][google.spanner.admin.instance.v1.InstanceConfig.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
* instanceAdminClient.deleteInstanceConfig(name);
* }
* }
*
* @param name Required. The name of the instance configuration to be deleted. Values are of the
* form `projects/<project>/instanceConfigs/<instance_config>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteInstanceConfig(InstanceConfigName name) {
DeleteInstanceConfigRequest request =
DeleteInstanceConfigRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteInstanceConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the instance configuration. Deletion is only allowed when no instances are using the
* configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`.
*
* Only user-managed configurations can be deleted.
*
*
Authorization requires `spanner.instanceConfigs.delete` permission on the resource
* [name][google.spanner.admin.instance.v1.InstanceConfig.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString();
* instanceAdminClient.deleteInstanceConfig(name);
* }
* }
*
* @param name Required. The name of the instance configuration to be deleted. Values are of the
* form `projects/<project>/instanceConfigs/<instance_config>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteInstanceConfig(String name) {
DeleteInstanceConfigRequest request =
DeleteInstanceConfigRequest.newBuilder().setName(name).build();
deleteInstanceConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the instance configuration. Deletion is only allowed when no instances are using the
* configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`.
*
* Only user-managed configurations can be deleted.
*
*
Authorization requires `spanner.instanceConfigs.delete` permission on the resource
* [name][google.spanner.admin.instance.v1.InstanceConfig.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* DeleteInstanceConfigRequest request =
* DeleteInstanceConfigRequest.newBuilder()
* .setName(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
* .setEtag("etag3123477")
* .setValidateOnly(true)
* .build();
* instanceAdminClient.deleteInstanceConfig(request);
* }
* }
*
* @param 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
*/
public final void deleteInstanceConfig(DeleteInstanceConfigRequest request) {
deleteInstanceConfigCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the instance configuration. Deletion is only allowed when no instances are using the
* configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`.
*
* Only user-managed configurations can be deleted.
*
*
Authorization requires `spanner.instanceConfigs.delete` permission on the resource
* [name][google.spanner.admin.instance.v1.InstanceConfig.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* DeleteInstanceConfigRequest request =
* DeleteInstanceConfigRequest.newBuilder()
* .setName(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
* .setEtag("etag3123477")
* .setValidateOnly(true)
* .build();
* ApiFuture future =
* instanceAdminClient.deleteInstanceConfigCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteInstanceConfigCallable() {
return stub.deleteInstanceConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the user-managed instance configuration [long-running
* operations][google.longrunning.Operation] in the given project. An instance configuration
* operation has a name of the form
* `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* for (Operation element :
* instanceAdminClient.listInstanceConfigOperations(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project of the instance configuration operations. Values are of the
* form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstanceConfigOperationsPagedResponse listInstanceConfigOperations(
ProjectName parent) {
ListInstanceConfigOperationsRequest request =
ListInstanceConfigOperationsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listInstanceConfigOperations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the user-managed instance configuration [long-running
* operations][google.longrunning.Operation] in the given project. An instance configuration
* operation has a name of the form
* `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* for (Operation element :
* instanceAdminClient.listInstanceConfigOperations(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The project of the instance configuration operations. Values are of the
* form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstanceConfigOperationsPagedResponse listInstanceConfigOperations(
String parent) {
ListInstanceConfigOperationsRequest request =
ListInstanceConfigOperationsRequest.newBuilder().setParent(parent).build();
return listInstanceConfigOperations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the user-managed instance configuration [long-running
* operations][google.longrunning.Operation] in the given project. An instance configuration
* operation has a name of the form
* `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstanceConfigOperationsRequest request =
* ListInstanceConfigOperationsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Operation element :
* instanceAdminClient.listInstanceConfigOperations(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListInstanceConfigOperationsPagedResponse listInstanceConfigOperations(
ListInstanceConfigOperationsRequest request) {
return listInstanceConfigOperationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the user-managed instance configuration [long-running
* operations][google.longrunning.Operation] in the given project. An instance configuration
* operation has a name of the form
* `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstanceConfigOperationsRequest request =
* ListInstanceConfigOperationsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* instanceAdminClient.listInstanceConfigOperationsPagedCallable().futureCall(request);
* // Do something.
* for (Operation element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable<
ListInstanceConfigOperationsRequest, ListInstanceConfigOperationsPagedResponse>
listInstanceConfigOperationsPagedCallable() {
return stub.listInstanceConfigOperationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists the user-managed instance configuration [long-running
* operations][google.longrunning.Operation] in the given project. An instance configuration
* operation has a name of the form
* `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstanceConfigOperationsRequest request =
* ListInstanceConfigOperationsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListInstanceConfigOperationsResponse response =
* instanceAdminClient.listInstanceConfigOperationsCallable().call(request);
* for (Operation element : response.getOperationsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable<
ListInstanceConfigOperationsRequest, ListInstanceConfigOperationsResponse>
listInstanceConfigOperationsCallable() {
return stub.listInstanceConfigOperationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instances in the given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* for (Instance element : instanceAdminClient.listInstances(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The name of the project for which a list of instances is requested.
* Values are of the form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstancesPagedResponse listInstances(ProjectName parent) {
ListInstancesRequest request =
ListInstancesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listInstances(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instances in the given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* for (Instance element : instanceAdminClient.listInstances(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The name of the project for which a list of instances is requested.
* Values are of the form `projects/<project>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstancesPagedResponse listInstances(String parent) {
ListInstancesRequest request = ListInstancesRequest.newBuilder().setParent(parent).build();
return listInstances(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instances in the given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancesRequest request =
* ListInstancesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setInstanceDeadline(Timestamp.newBuilder().build())
* .build();
* for (Instance element : instanceAdminClient.listInstances(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListInstancesPagedResponse listInstances(ListInstancesRequest request) {
return listInstancesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instances in the given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancesRequest request =
* ListInstancesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setInstanceDeadline(Timestamp.newBuilder().build())
* .build();
* ApiFuture future =
* instanceAdminClient.listInstancesPagedCallable().futureCall(request);
* // Do something.
* for (Instance element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listInstancesPagedCallable() {
return stub.listInstancesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instances in the given project.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancesRequest request =
* ListInstancesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .setInstanceDeadline(Timestamp.newBuilder().build())
* .build();
* while (true) {
* ListInstancesResponse response = instanceAdminClient.listInstancesCallable().call(request);
* for (Instance element : response.getInstancesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listInstancesCallable() {
return stub.listInstancesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instance partitions for the given instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
* for (InstancePartition element :
* instanceAdminClient.listInstancePartitions(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The instance whose instance partitions should be listed. Values are of
* the form `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstancePartitionsPagedResponse listInstancePartitions(InstanceName parent) {
ListInstancePartitionsRequest request =
ListInstancePartitionsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listInstancePartitions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instance partitions for the given instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
* for (InstancePartition element :
* instanceAdminClient.listInstancePartitions(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The instance whose instance partitions should be listed. Values are of
* the form `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstancePartitionsPagedResponse listInstancePartitions(String parent) {
ListInstancePartitionsRequest request =
ListInstancePartitionsRequest.newBuilder().setParent(parent).build();
return listInstancePartitions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instance partitions for the given instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancePartitionsRequest request =
* ListInstancePartitionsRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setInstancePartitionDeadline(Timestamp.newBuilder().build())
* .build();
* for (InstancePartition element :
* instanceAdminClient.listInstancePartitions(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListInstancePartitionsPagedResponse listInstancePartitions(
ListInstancePartitionsRequest request) {
return listInstancePartitionsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instance partitions for the given instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancePartitionsRequest request =
* ListInstancePartitionsRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setInstancePartitionDeadline(Timestamp.newBuilder().build())
* .build();
* ApiFuture future =
* instanceAdminClient.listInstancePartitionsPagedCallable().futureCall(request);
* // Do something.
* for (InstancePartition element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listInstancePartitionsPagedCallable() {
return stub.listInstancePartitionsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all instance partitions for the given instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancePartitionsRequest request =
* ListInstancePartitionsRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setInstancePartitionDeadline(Timestamp.newBuilder().build())
* .build();
* while (true) {
* ListInstancePartitionsResponse response =
* instanceAdminClient.listInstancePartitionsCallable().call(request);
* for (InstancePartition element : response.getInstancePartitionsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listInstancePartitionsCallable() {
return stub.listInstancePartitionsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
* Instance response = instanceAdminClient.getInstance(name);
* }
* }
*
* @param name Required. The name of the requested instance. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Instance getInstance(InstanceName name) {
GetInstanceRequest request =
GetInstanceRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getInstance(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
* Instance response = instanceAdminClient.getInstance(name);
* }
* }
*
* @param name Required. The name of the requested instance. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Instance getInstance(String name) {
GetInstanceRequest request = GetInstanceRequest.newBuilder().setName(name).build();
return getInstance(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* GetInstanceRequest request =
* GetInstanceRequest.newBuilder()
* .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setFieldMask(FieldMask.newBuilder().build())
* .build();
* Instance response = instanceAdminClient.getInstance(request);
* }
* }
*
* @param 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
*/
public final Instance getInstance(GetInstanceRequest request) {
return getInstanceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* GetInstanceRequest request =
* GetInstanceRequest.newBuilder()
* .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setFieldMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future = instanceAdminClient.getInstanceCallable().futureCall(request);
* // Do something.
* Instance response = future.get();
* }
* }
*/
public final UnaryCallable getInstanceCallable() {
return stub.getInstanceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance and begins preparing it to begin serving. The returned [long-running
* operation][google.longrunning.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,
* `CreateInstance` returns `ALREADY_EXISTS`.
*
* 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 API. * The instance's state
* becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track
* creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* String instanceId = "instanceId902024336";
* Instance instance = Instance.newBuilder().build();
* Instance response =
* instanceAdminClient.createInstanceAsync(parent, instanceId, instance).get();
* }
* }
*
* @param parent Required. The name of the project in which to create the instance. Values are of
* the form `projects/<project>`.
* @param instanceId Required. The ID of the instance to create. Valid identifiers are of the form
* `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length.
* @param instance Required. The instance to create. The name may be omitted, but if specified
* must be `<parent>/instances/<instance_id>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createInstanceAsync(
ProjectName parent, String instanceId, Instance instance) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setInstanceId(instanceId)
.setInstance(instance)
.build();
return createInstanceAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance and begins preparing it to begin serving. The returned [long-running
* operation][google.longrunning.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,
* `CreateInstance` returns `ALREADY_EXISTS`.
*
* 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 API. * The instance's state
* becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track
* creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* String instanceId = "instanceId902024336";
* Instance instance = Instance.newBuilder().build();
* Instance response =
* instanceAdminClient.createInstanceAsync(parent, instanceId, instance).get();
* }
* }
*
* @param parent Required. The name of the project in which to create the instance. Values are of
* the form `projects/<project>`.
* @param instanceId Required. The ID of the instance to create. Valid identifiers are of the form
* `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length.
* @param instance Required. The instance to create. The name may be omitted, but if specified
* must be `<parent>/instances/<instance_id>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createInstanceAsync(
String parent, String instanceId, Instance instance) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(parent)
.setInstanceId(instanceId)
.setInstance(instance)
.build();
return createInstanceAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance and begins preparing it to begin serving. The returned [long-running
* operation][google.longrunning.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,
* `CreateInstance` returns `ALREADY_EXISTS`.
*
* 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 API. * The instance's state
* becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track
* creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstanceRequest request =
* CreateInstanceRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setInstanceId("instanceId902024336")
* .setInstance(Instance.newBuilder().build())
* .build();
* Instance response = instanceAdminClient.createInstanceAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture createInstanceAsync(
CreateInstanceRequest request) {
return createInstanceOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance and begins preparing it to begin serving. The returned [long-running
* operation][google.longrunning.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,
* `CreateInstance` returns `ALREADY_EXISTS`.
*
* 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 API. * The instance's state
* becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track
* creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstanceRequest request =
* CreateInstanceRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setInstanceId("instanceId902024336")
* .setInstance(Instance.newBuilder().build())
* .build();
* OperationFuture future =
* instanceAdminClient.createInstanceOperationCallable().futureCall(request);
* // Do something.
* Instance response = future.get();
* }
* }
*/
public final OperationCallable
createInstanceOperationCallable() {
return stub.createInstanceOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance and begins preparing it to begin serving. The returned [long-running
* operation][google.longrunning.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,
* `CreateInstance` returns `ALREADY_EXISTS`.
*
* 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 API. * The instance's state
* becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track
* creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstanceRequest request =
* CreateInstanceRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setInstanceId("instanceId902024336")
* .setInstance(Instance.newBuilder().build())
* .build();
* ApiFuture future =
* instanceAdminClient.createInstanceCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable createInstanceCallable() {
return stub.createInstanceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance, and begins allocating or releasing resources as requested. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* updating the instance. If the named instance does not exist, returns `NOT_FOUND`.
*
* 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][google.spanner.admin.instance.v1.UpdateInstanceMetadata.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.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track the
* instance modification. The [metadata][google.longrunning.Operation.metadata] field type is
* [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Authorization requires `spanner.instances.update` permission on the resource
* [name][google.spanner.admin.instance.v1.Instance.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* Instance instance = Instance.newBuilder().build();
* FieldMask fieldMask = FieldMask.newBuilder().build();
* Instance response = instanceAdminClient.updateInstanceAsync(instance, fieldMask).get();
* }
* }
*
* @param instance Required. The instance to update, which must always include the instance name.
* Otherwise, only fields mentioned in
* [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be
* included.
* @param fieldMask Required. A mask specifying which fields in
* [Instance][google.spanner.admin.instance.v1.Instance] should be updated. The field mask
* must always be specified; this prevents any future fields in
* [Instance][google.spanner.admin.instance.v1.Instance] from being erased accidentally by
* clients that do not know about them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture updateInstanceAsync(
Instance instance, FieldMask fieldMask) {
UpdateInstanceRequest request =
UpdateInstanceRequest.newBuilder().setInstance(instance).setFieldMask(fieldMask).build();
return updateInstanceAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance, and begins allocating or releasing resources as requested. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* updating the instance. If the named instance does not exist, returns `NOT_FOUND`.
*
* 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][google.spanner.admin.instance.v1.UpdateInstanceMetadata.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.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track the
* instance modification. The [metadata][google.longrunning.Operation.metadata] field type is
* [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Authorization requires `spanner.instances.update` permission on the resource
* [name][google.spanner.admin.instance.v1.Instance.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstanceRequest request =
* UpdateInstanceRequest.newBuilder()
* .setInstance(Instance.newBuilder().build())
* .setFieldMask(FieldMask.newBuilder().build())
* .build();
* Instance response = instanceAdminClient.updateInstanceAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture updateInstanceAsync(
UpdateInstanceRequest request) {
return updateInstanceOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance, and begins allocating or releasing resources as requested. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* updating the instance. If the named instance does not exist, returns `NOT_FOUND`.
*
* 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][google.spanner.admin.instance.v1.UpdateInstanceMetadata.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.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track the
* instance modification. The [metadata][google.longrunning.Operation.metadata] field type is
* [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Authorization requires `spanner.instances.update` permission on the resource
* [name][google.spanner.admin.instance.v1.Instance.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstanceRequest request =
* UpdateInstanceRequest.newBuilder()
* .setInstance(Instance.newBuilder().build())
* .setFieldMask(FieldMask.newBuilder().build())
* .build();
* OperationFuture future =
* instanceAdminClient.updateInstanceOperationCallable().futureCall(request);
* // Do something.
* Instance response = future.get();
* }
* }
*/
public final OperationCallable
updateInstanceOperationCallable() {
return stub.updateInstanceOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance, and begins allocating or releasing resources as requested. The returned
* [long-running operation][google.longrunning.Operation] can be used to track the progress of
* updating the instance. If the named instance does not exist, returns `NOT_FOUND`.
*
* 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][google.spanner.admin.instance.v1.UpdateInstanceMetadata.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.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_name>/operations/<operation_id>` and can be used to track the
* instance modification. The [metadata][google.longrunning.Operation.metadata] field type is
* [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful.
*
*
Authorization requires `spanner.instances.update` permission on the resource
* [name][google.spanner.admin.instance.v1.Instance.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstanceRequest request =
* UpdateInstanceRequest.newBuilder()
* .setInstance(Instance.newBuilder().build())
* .setFieldMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* instanceAdminClient.updateInstanceCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable updateInstanceCallable() {
return stub.updateInstanceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an instance.
*
* Immediately upon completion of the request:
*
*
* Billing ceases for all of the instance's reserved resources.
*
*
Soon afterward:
*
*
* The instance and *all of its databases* immediately and irrevocably disappear
* from the API. All data in the databases is permanently deleted.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
* instanceAdminClient.deleteInstance(name);
* }
* }
*
* @param name Required. The name of the instance to be deleted. Values are of the form
* `projects/<project>/instances/<instance>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteInstance(InstanceName name) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteInstance(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an instance.
*
* Immediately upon completion of the request:
*
*
* Billing ceases for all of the instance's reserved resources.
*
*
Soon afterward:
*
*
* The instance and *all of its databases* immediately and irrevocably disappear
* from the API. All data in the databases is permanently deleted.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
* instanceAdminClient.deleteInstance(name);
* }
* }
*
* @param name Required. The name of the instance to be deleted. Values are of the form
* `projects/<project>/instances/<instance>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteInstance(String name) {
DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder().setName(name).build();
deleteInstance(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an instance.
*
* Immediately upon completion of the request:
*
*
* Billing ceases for all of the instance's reserved resources.
*
*
Soon afterward:
*
*
* The instance and *all of its databases* immediately and irrevocably disappear
* from the API. All data in the databases is permanently deleted.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* DeleteInstanceRequest request =
* DeleteInstanceRequest.newBuilder()
* .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .build();
* instanceAdminClient.deleteInstance(request);
* }
* }
*
* @param 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
*/
public final void deleteInstance(DeleteInstanceRequest request) {
deleteInstanceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an instance.
*
* Immediately upon completion of the request:
*
*
* Billing ceases for all of the instance's reserved resources.
*
*
Soon afterward:
*
*
* The instance and *all of its databases* immediately and irrevocably disappear
* from the API. All data in the databases is permanently deleted.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* DeleteInstanceRequest request =
* DeleteInstanceRequest.newBuilder()
* .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .build();
* ApiFuture future = instanceAdminClient.deleteInstanceCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteInstanceCallable() {
return stub.deleteInstanceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on an instance resource. Replaces any existing policy.
*
* Authorization requires `spanner.instances.setIamPolicy` on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ResourceName resource = InstanceName.of("[PROJECT]", "[INSTANCE]");
* Policy policy = Policy.newBuilder().build();
* Policy response = instanceAdminClient.setIamPolicy(resource, policy);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
* policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
* Platform services (such as Projects) might reject them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(ResourceName resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.setPolicy(policy)
.build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on an instance resource. Replaces any existing policy.
*
* Authorization requires `spanner.instances.setIamPolicy` on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String resource = ProjectName.of("[PROJECT]").toString();
* Policy policy = Policy.newBuilder().build();
* Policy response = instanceAdminClient.setIamPolicy(resource, policy);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
* policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
* Platform services (such as Projects) might reject them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(String resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder().setResource(resource).setPolicy(policy).build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on an instance resource. Replaces any existing policy.
*
* Authorization requires `spanner.instances.setIamPolicy` on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Policy response = instanceAdminClient.setIamPolicy(request);
* }
* }
*
* @param 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
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on an instance resource. Replaces any existing policy.
*
* Authorization requires `spanner.instances.setIamPolicy` on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future = instanceAdminClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for an instance resource. Returns an empty policy if an instance
* exists but does not have a policy set.
*
* Authorization requires `spanner.instances.getIamPolicy` on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ResourceName resource = InstanceName.of("[PROJECT]", "[INSTANCE]");
* Policy response = instanceAdminClient.getIamPolicy(resource);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(ResourceName resource) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for an instance resource. Returns an empty policy if an instance
* exists but does not have a policy set.
*
* Authorization requires `spanner.instances.getIamPolicy` on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String resource = ProjectName.of("[PROJECT]").toString();
* Policy response = instanceAdminClient.getIamPolicy(resource);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(String resource) {
GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder().setResource(resource).build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for an instance resource. Returns an empty policy if an instance
* exists but does not have a policy set.
*
* Authorization requires `spanner.instances.getIamPolicy` on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* Policy response = instanceAdminClient.getIamPolicy(request);
* }
* }
*
* @param 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
*/
public final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for an instance resource. Returns an empty policy if an instance
* exists but does not have a policy set.
*
* Authorization requires `spanner.instances.getIamPolicy` on
* [resource][google.iam.v1.GetIamPolicyRequest.resource].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* ApiFuture future = instanceAdminClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that the caller has on the specified instance resource.
*
* Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a
* NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google
* Cloud Project. Otherwise returns an empty set of permissions.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ResourceName resource = InstanceName.of("[PROJECT]", "[INSTANCE]");
* List permissions = new ArrayList<>();
* TestIamPermissionsResponse response =
* instanceAdminClient.testIamPermissions(resource, permissions);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
ResourceName resource, List permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that the caller has on the specified instance resource.
*
* Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a
* NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google
* Cloud Project. Otherwise returns an empty set of permissions.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String resource = ProjectName.of("[PROJECT]").toString();
* List permissions = new ArrayList<>();
* TestIamPermissionsResponse response =
* instanceAdminClient.testIamPermissions(resource, permissions);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
String resource, List permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource)
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that the caller has on the specified instance resource.
*
* Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a
* NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google
* Cloud Project. Otherwise returns an empty set of permissions.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .addAllPermissions(new ArrayList())
* .build();
* TestIamPermissionsResponse response = instanceAdminClient.testIamPermissions(request);
* }
* }
*
* @param 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
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that the caller has on the specified instance resource.
*
* Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a
* NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google
* Cloud Project. Otherwise returns an empty set of permissions.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .addAllPermissions(new ArrayList())
* .build();
* ApiFuture future =
* instanceAdminClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance partition.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstancePartitionName name =
* InstancePartitionName.of("[PROJECT]", "[INSTANCE]", "[INSTANCE_PARTITION]");
* InstancePartition response = instanceAdminClient.getInstancePartition(name);
* }
* }
*
* @param name Required. The name of the requested instance partition. Values are of the form
* `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final InstancePartition getInstancePartition(InstancePartitionName name) {
GetInstancePartitionRequest request =
GetInstancePartitionRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getInstancePartition(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance partition.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String name =
* InstancePartitionName.of("[PROJECT]", "[INSTANCE]", "[INSTANCE_PARTITION]").toString();
* InstancePartition response = instanceAdminClient.getInstancePartition(name);
* }
* }
*
* @param name Required. The name of the requested instance partition. Values are of the form
* `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final InstancePartition getInstancePartition(String name) {
GetInstancePartitionRequest request =
GetInstancePartitionRequest.newBuilder().setName(name).build();
return getInstancePartition(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance partition.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* GetInstancePartitionRequest request =
* GetInstancePartitionRequest.newBuilder()
* .setName(
* InstancePartitionName.of("[PROJECT]", "[INSTANCE]", "[INSTANCE_PARTITION]")
* .toString())
* .build();
* InstancePartition response = instanceAdminClient.getInstancePartition(request);
* }
* }
*
* @param 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
*/
public final InstancePartition getInstancePartition(GetInstancePartitionRequest request) {
return getInstancePartitionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a particular instance partition.
*
* Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* GetInstancePartitionRequest request =
* GetInstancePartitionRequest.newBuilder()
* .setName(
* InstancePartitionName.of("[PROJECT]", "[INSTANCE]", "[INSTANCE_PARTITION]")
* .toString())
* .build();
* ApiFuture future =
* instanceAdminClient.getInstancePartitionCallable().futureCall(request);
* // Do something.
* InstancePartition response = future.get();
* }
* }
*/
public final UnaryCallable
getInstancePartitionCallable() {
return stub.getInstancePartitionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance partition and begins preparing it to be used. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of preparing the new
* instance partition. The instance partition name is assigned by the caller. If the named
* instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`.
*
* Immediately upon completion of this request:
*
*
* The instance partition 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 partition immediately unreadable via the
* API. * The instance partition can be deleted. * All other attempts to modify the
* instance partition 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 start using this instance partition. * The
* instance partition's allocated resource levels are readable via the API. * The instance
* partition's state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track creation of the instance partition. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
* InstancePartition instancePartition = InstancePartition.newBuilder().build();
* String instancePartitionId = "instancePartitionId1364450768";
* InstancePartition response =
* instanceAdminClient
* .createInstancePartitionAsync(parent, instancePartition, instancePartitionId)
* .get();
* }
* }
*
* @param parent Required. The name of the instance in which to create the instance partition.
* Values are of the form `projects/<project>/instances/<instance>`.
* @param instancePartition Required. The instance partition to create. The
* instance_partition.name may be omitted, but if specified must be
* `<parent>/instancePartitions/<instance_partition_id>`.
* @param instancePartitionId Required. The ID of the instance partition to create. Valid
* identifiers are of the form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64
* characters in length.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
createInstancePartitionAsync(
InstanceName parent, InstancePartition instancePartition, String instancePartitionId) {
CreateInstancePartitionRequest request =
CreateInstancePartitionRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setInstancePartition(instancePartition)
.setInstancePartitionId(instancePartitionId)
.build();
return createInstancePartitionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance partition and begins preparing it to be used. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of preparing the new
* instance partition. The instance partition name is assigned by the caller. If the named
* instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`.
*
* Immediately upon completion of this request:
*
*
* The instance partition 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 partition immediately unreadable via the
* API. * The instance partition can be deleted. * All other attempts to modify the
* instance partition 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 start using this instance partition. * The
* instance partition's allocated resource levels are readable via the API. * The instance
* partition's state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track creation of the instance partition. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
* InstancePartition instancePartition = InstancePartition.newBuilder().build();
* String instancePartitionId = "instancePartitionId1364450768";
* InstancePartition response =
* instanceAdminClient
* .createInstancePartitionAsync(parent, instancePartition, instancePartitionId)
* .get();
* }
* }
*
* @param parent Required. The name of the instance in which to create the instance partition.
* Values are of the form `projects/<project>/instances/<instance>`.
* @param instancePartition Required. The instance partition to create. The
* instance_partition.name may be omitted, but if specified must be
* `<parent>/instancePartitions/<instance_partition_id>`.
* @param instancePartitionId Required. The ID of the instance partition to create. Valid
* identifiers are of the form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64
* characters in length.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
createInstancePartitionAsync(
String parent, InstancePartition instancePartition, String instancePartitionId) {
CreateInstancePartitionRequest request =
CreateInstancePartitionRequest.newBuilder()
.setParent(parent)
.setInstancePartition(instancePartition)
.setInstancePartitionId(instancePartitionId)
.build();
return createInstancePartitionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance partition and begins preparing it to be used. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of preparing the new
* instance partition. The instance partition name is assigned by the caller. If the named
* instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`.
*
* Immediately upon completion of this request:
*
*
* The instance partition 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 partition immediately unreadable via the
* API. * The instance partition can be deleted. * All other attempts to modify the
* instance partition 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 start using this instance partition. * The
* instance partition's allocated resource levels are readable via the API. * The instance
* partition's state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track creation of the instance partition. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstancePartitionRequest request =
* CreateInstancePartitionRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setInstancePartitionId("instancePartitionId1364450768")
* .setInstancePartition(InstancePartition.newBuilder().build())
* .build();
* InstancePartition response = instanceAdminClient.createInstancePartitionAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture
createInstancePartitionAsync(CreateInstancePartitionRequest request) {
return createInstancePartitionOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance partition and begins preparing it to be used. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of preparing the new
* instance partition. The instance partition name is assigned by the caller. If the named
* instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`.
*
* Immediately upon completion of this request:
*
*
* The instance partition 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 partition immediately unreadable via the
* API. * The instance partition can be deleted. * All other attempts to modify the
* instance partition 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 start using this instance partition. * The
* instance partition's allocated resource levels are readable via the API. * The instance
* partition's state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track creation of the instance partition. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstancePartitionRequest request =
* CreateInstancePartitionRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setInstancePartitionId("instancePartitionId1364450768")
* .setInstancePartition(InstancePartition.newBuilder().build())
* .build();
* OperationFuture future =
* instanceAdminClient.createInstancePartitionOperationCallable().futureCall(request);
* // Do something.
* InstancePartition response = future.get();
* }
* }
*/
public final OperationCallable<
CreateInstancePartitionRequest, InstancePartition, CreateInstancePartitionMetadata>
createInstancePartitionOperationCallable() {
return stub.createInstancePartitionOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an instance partition and begins preparing it to be used. The returned [long-running
* operation][google.longrunning.Operation] can be used to track the progress of preparing the new
* instance partition. The instance partition name is assigned by the caller. If the named
* instance partition already exists, `CreateInstancePartition` returns `ALREADY_EXISTS`.
*
* Immediately upon completion of this request:
*
*
* The instance partition 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 partition immediately unreadable via the
* API. * The instance partition can be deleted. * All other attempts to modify the
* instance partition 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 start using this instance partition. * The
* instance partition's allocated resource levels are readable via the API. * The instance
* partition's state becomes `READY`.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track creation of the instance partition. The [metadata][google.longrunning.Operation.metadata]
* field type is
* [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* CreateInstancePartitionRequest request =
* CreateInstancePartitionRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setInstancePartitionId("instancePartitionId1364450768")
* .setInstancePartition(InstancePartition.newBuilder().build())
* .build();
* ApiFuture future =
* instanceAdminClient.createInstancePartitionCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
createInstancePartitionCallable() {
return stub.createInstancePartitionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing instance partition. Requires that the instance partition is not used by any
* database or backup and is not the default instance partition of an instance.
*
* Authorization requires `spanner.instancePartitions.delete` permission on the resource
* [name][google.spanner.admin.instance.v1.InstancePartition.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstancePartitionName name =
* InstancePartitionName.of("[PROJECT]", "[INSTANCE]", "[INSTANCE_PARTITION]");
* instanceAdminClient.deleteInstancePartition(name);
* }
* }
*
* @param name Required. The name of the instance partition to be deleted. Values are of the form
* `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteInstancePartition(InstancePartitionName name) {
DeleteInstancePartitionRequest request =
DeleteInstancePartitionRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteInstancePartition(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing instance partition. Requires that the instance partition is not used by any
* database or backup and is not the default instance partition of an instance.
*
* Authorization requires `spanner.instancePartitions.delete` permission on the resource
* [name][google.spanner.admin.instance.v1.InstancePartition.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String name =
* InstancePartitionName.of("[PROJECT]", "[INSTANCE]", "[INSTANCE_PARTITION]").toString();
* instanceAdminClient.deleteInstancePartition(name);
* }
* }
*
* @param name Required. The name of the instance partition to be deleted. Values are of the form
* `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteInstancePartition(String name) {
DeleteInstancePartitionRequest request =
DeleteInstancePartitionRequest.newBuilder().setName(name).build();
deleteInstancePartition(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing instance partition. Requires that the instance partition is not used by any
* database or backup and is not the default instance partition of an instance.
*
* Authorization requires `spanner.instancePartitions.delete` permission on the resource
* [name][google.spanner.admin.instance.v1.InstancePartition.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* DeleteInstancePartitionRequest request =
* DeleteInstancePartitionRequest.newBuilder()
* .setName(
* InstancePartitionName.of("[PROJECT]", "[INSTANCE]", "[INSTANCE_PARTITION]")
* .toString())
* .setEtag("etag3123477")
* .build();
* instanceAdminClient.deleteInstancePartition(request);
* }
* }
*
* @param 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
*/
public final void deleteInstancePartition(DeleteInstancePartitionRequest request) {
deleteInstancePartitionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing instance partition. Requires that the instance partition is not used by any
* database or backup and is not the default instance partition of an instance.
*
* Authorization requires `spanner.instancePartitions.delete` permission on the resource
* [name][google.spanner.admin.instance.v1.InstancePartition.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* DeleteInstancePartitionRequest request =
* DeleteInstancePartitionRequest.newBuilder()
* .setName(
* InstancePartitionName.of("[PROJECT]", "[INSTANCE]", "[INSTANCE_PARTITION]")
* .toString())
* .setEtag("etag3123477")
* .build();
* ApiFuture future =
* instanceAdminClient.deleteInstancePartitionCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
deleteInstancePartitionCallable() {
return stub.deleteInstancePartitionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance partition, and begins allocating or releasing resources as requested. The
* returned [long-running operation][google.longrunning.Operation] can be used to track the
* progress of updating the instance partition. If the named instance partition does not exist,
* returns `NOT_FOUND`.
*
* Immediately upon completion of this request:
*
*
* For resource types for which a decrease in the instance partition'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][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata.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 partition are rejected. * Reading
* the instance partition 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 partition's tables. * The instance partition's new resource levels are readable
* via the API.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track the instance partition modification. The
* [metadata][google.longrunning.Operation.metadata] field type is
* [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Authorization requires `spanner.instancePartitions.update` permission on the resource
* [name][google.spanner.admin.instance.v1.InstancePartition.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstancePartition instancePartition = InstancePartition.newBuilder().build();
* FieldMask fieldMask = FieldMask.newBuilder().build();
* InstancePartition response =
* instanceAdminClient.updateInstancePartitionAsync(instancePartition, fieldMask).get();
* }
* }
*
* @param instancePartition Required. The instance partition to update, which must always include
* the instance partition name. Otherwise, only fields mentioned in
* [field_mask][google.spanner.admin.instance.v1.UpdateInstancePartitionRequest.field_mask]
* need be included.
* @param fieldMask Required. A mask specifying which fields in
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition] should be updated.
* The field mask must always be specified; this prevents any future fields in
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition] from being erased
* accidentally by clients that do not know about them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
updateInstancePartitionAsync(InstancePartition instancePartition, FieldMask fieldMask) {
UpdateInstancePartitionRequest request =
UpdateInstancePartitionRequest.newBuilder()
.setInstancePartition(instancePartition)
.setFieldMask(fieldMask)
.build();
return updateInstancePartitionAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance partition, and begins allocating or releasing resources as requested. The
* returned [long-running operation][google.longrunning.Operation] can be used to track the
* progress of updating the instance partition. If the named instance partition does not exist,
* returns `NOT_FOUND`.
*
* Immediately upon completion of this request:
*
*
* For resource types for which a decrease in the instance partition'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][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata.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 partition are rejected. * Reading
* the instance partition 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 partition's tables. * The instance partition's new resource levels are readable
* via the API.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track the instance partition modification. The
* [metadata][google.longrunning.Operation.metadata] field type is
* [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Authorization requires `spanner.instancePartitions.update` permission on the resource
* [name][google.spanner.admin.instance.v1.InstancePartition.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstancePartitionRequest request =
* UpdateInstancePartitionRequest.newBuilder()
* .setInstancePartition(InstancePartition.newBuilder().build())
* .setFieldMask(FieldMask.newBuilder().build())
* .build();
* InstancePartition response = instanceAdminClient.updateInstancePartitionAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture
updateInstancePartitionAsync(UpdateInstancePartitionRequest request) {
return updateInstancePartitionOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance partition, and begins allocating or releasing resources as requested. The
* returned [long-running operation][google.longrunning.Operation] can be used to track the
* progress of updating the instance partition. If the named instance partition does not exist,
* returns `NOT_FOUND`.
*
* Immediately upon completion of this request:
*
*
* For resource types for which a decrease in the instance partition'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][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata.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 partition are rejected. * Reading
* the instance partition 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 partition's tables. * The instance partition's new resource levels are readable
* via the API.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track the instance partition modification. The
* [metadata][google.longrunning.Operation.metadata] field type is
* [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Authorization requires `spanner.instancePartitions.update` permission on the resource
* [name][google.spanner.admin.instance.v1.InstancePartition.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstancePartitionRequest request =
* UpdateInstancePartitionRequest.newBuilder()
* .setInstancePartition(InstancePartition.newBuilder().build())
* .setFieldMask(FieldMask.newBuilder().build())
* .build();
* OperationFuture future =
* instanceAdminClient.updateInstancePartitionOperationCallable().futureCall(request);
* // Do something.
* InstancePartition response = future.get();
* }
* }
*/
public final OperationCallable<
UpdateInstancePartitionRequest, InstancePartition, UpdateInstancePartitionMetadata>
updateInstancePartitionOperationCallable() {
return stub.updateInstancePartitionOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an instance partition, and begins allocating or releasing resources as requested. The
* returned [long-running operation][google.longrunning.Operation] can be used to track the
* progress of updating the instance partition. If the named instance partition does not exist,
* returns `NOT_FOUND`.
*
* Immediately upon completion of this request:
*
*
* For resource types for which a decrease in the instance partition'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][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata.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 partition are rejected. * Reading
* the instance partition 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 partition's tables. * The instance partition's new resource levels are readable
* via the API.
*
*
The returned [long-running operation][google.longrunning.Operation] will have a name of the
* format `<instance_partition_name>/operations/<operation_id>` and can be used to
* track the instance partition modification. The
* [metadata][google.longrunning.Operation.metadata] field type is
* [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata].
* The [response][google.longrunning.Operation.response] field type is
* [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if successful.
*
*
Authorization requires `spanner.instancePartitions.update` permission on the resource
* [name][google.spanner.admin.instance.v1.InstancePartition.name].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* UpdateInstancePartitionRequest request =
* UpdateInstancePartitionRequest.newBuilder()
* .setInstancePartition(InstancePartition.newBuilder().build())
* .setFieldMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* instanceAdminClient.updateInstancePartitionCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
updateInstancePartitionCallable() {
return stub.updateInstancePartitionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists instance partition [long-running operations][google.longrunning.Operation] in the given
* instance. An instance partition operation has a name of the form
* `projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Authorization requires `spanner.instancePartitionOperations.list` permission on the resource
* [parent][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
* for (Operation element :
* instanceAdminClient.listInstancePartitionOperations(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent instance of the instance partition operations. Values are of
* the form `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstancePartitionOperationsPagedResponse listInstancePartitionOperations(
InstanceName parent) {
ListInstancePartitionOperationsRequest request =
ListInstancePartitionOperationsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listInstancePartitionOperations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists instance partition [long-running operations][google.longrunning.Operation] in the given
* instance. An instance partition operation has a name of the form
* `projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Authorization requires `spanner.instancePartitionOperations.list` permission on the resource
* [parent][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
* for (Operation element :
* instanceAdminClient.listInstancePartitionOperations(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent instance of the instance partition operations. Values are of
* the form `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstancePartitionOperationsPagedResponse listInstancePartitionOperations(
String parent) {
ListInstancePartitionOperationsRequest request =
ListInstancePartitionOperationsRequest.newBuilder().setParent(parent).build();
return listInstancePartitionOperations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists instance partition [long-running operations][google.longrunning.Operation] in the given
* instance. An instance partition operation has a name of the form
* `projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Authorization requires `spanner.instancePartitionOperations.list` permission on the resource
* [parent][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancePartitionOperationsRequest request =
* ListInstancePartitionOperationsRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setInstancePartitionDeadline(Timestamp.newBuilder().build())
* .build();
* for (Operation element :
* instanceAdminClient.listInstancePartitionOperations(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListInstancePartitionOperationsPagedResponse listInstancePartitionOperations(
ListInstancePartitionOperationsRequest request) {
return listInstancePartitionOperationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists instance partition [long-running operations][google.longrunning.Operation] in the given
* instance. An instance partition operation has a name of the form
* `projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Authorization requires `spanner.instancePartitionOperations.list` permission on the resource
* [parent][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancePartitionOperationsRequest request =
* ListInstancePartitionOperationsRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setInstancePartitionDeadline(Timestamp.newBuilder().build())
* .build();
* ApiFuture future =
* instanceAdminClient.listInstancePartitionOperationsPagedCallable().futureCall(request);
* // Do something.
* for (Operation element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable<
ListInstancePartitionOperationsRequest, ListInstancePartitionOperationsPagedResponse>
listInstancePartitionOperationsPagedCallable() {
return stub.listInstancePartitionOperationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists instance partition [long-running operations][google.longrunning.Operation] in the given
* instance. An instance partition operation has a name of the form
* `projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/operations/<operation>`.
* The long-running operation [metadata][google.longrunning.Operation.metadata] field type
* `metadata.type_url` describes the type of the metadata. Operations returned include those that
* have completed/failed/canceled within the last 7 days, and pending operations. Operations
* returned are ordered by `operation.metadata.value.start_time` in descending order starting from
* the most recently started operation.
*
* Authorization requires `spanner.instancePartitionOperations.list` permission on the resource
* [parent][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.parent].
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* ListInstancePartitionOperationsRequest request =
* ListInstancePartitionOperationsRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setInstancePartitionDeadline(Timestamp.newBuilder().build())
* .build();
* while (true) {
* ListInstancePartitionOperationsResponse response =
* instanceAdminClient.listInstancePartitionOperationsCallable().call(request);
* for (Operation element : response.getOperationsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable<
ListInstancePartitionOperationsRequest, ListInstancePartitionOperationsResponse>
listInstancePartitionOperationsCallable() {
return stub.listInstancePartitionOperationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moves an instance to the target instance configuration. You can use the returned [long-running
* operation][google.longrunning.Operation] to track the progress of moving the instance.
*
* `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following
* criteria:
*
*
* Is undergoing a move to a different instance configuration * Has backups * Has
* an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance
*
*
While the operation is pending:
*
*
* All other attempts to modify the instance, including changes to its compute capacity,
* are rejected. * The following database and backup admin operations are rejected:
*
*
* `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if
* default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` *
* `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup`
*
*
* Both the source and target instance configurations are subject to hourly compute and
* storage charges. * The instance might experience higher read-write latencies and a higher
* transaction abort rate. However, moving an instance doesn't cause any downtime.
*
*
The returned [long-running operation][google.longrunning.Operation] has a name of the format
* `<instance_name>/operations/<operation_id>` and can be used to track the move
* instance operation. The [metadata][google.longrunning.Operation.metadata] field type is
* [MoveInstanceMetadata][google.spanner.admin.instance.v1.MoveInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful. Cancelling the operation
* sets its metadata's
* [cancel_time][google.spanner.admin.instance.v1.MoveInstanceMetadata.cancel_time]. Cancellation
* is not immediate because it involves moving any data previously moved to the target instance
* configuration back to the original instance configuration. You can use this operation to track
* the progress of the cancellation. Upon successful completion of the cancellation, the operation
* terminates with `CANCELLED` status.
*
*
If not cancelled, upon completion of the returned operation:
*
*
* The instance successfully moves to the target instance configuration. * You are
* billed for compute and storage in target instance configuration.
*
*
Authorization requires the `spanner.instances.update` permission on the resource
* [instance][google.spanner.admin.instance.v1.Instance].
*
*
For more details, see [Move an
* instance](https://cloud.google.com/spanner/docs/move-instance).
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* MoveInstanceRequest request =
* MoveInstanceRequest.newBuilder()
* .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setTargetConfig(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
* .build();
* MoveInstanceResponse response = instanceAdminClient.moveInstanceAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture moveInstanceAsync(
MoveInstanceRequest request) {
return moveInstanceOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moves an instance to the target instance configuration. You can use the returned [long-running
* operation][google.longrunning.Operation] to track the progress of moving the instance.
*
* `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following
* criteria:
*
*
* Is undergoing a move to a different instance configuration * Has backups * Has
* an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance
*
*
While the operation is pending:
*
*
* All other attempts to modify the instance, including changes to its compute capacity,
* are rejected. * The following database and backup admin operations are rejected:
*
*
* `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if
* default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` *
* `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup`
*
*
* Both the source and target instance configurations are subject to hourly compute and
* storage charges. * The instance might experience higher read-write latencies and a higher
* transaction abort rate. However, moving an instance doesn't cause any downtime.
*
*
The returned [long-running operation][google.longrunning.Operation] has a name of the format
* `<instance_name>/operations/<operation_id>` and can be used to track the move
* instance operation. The [metadata][google.longrunning.Operation.metadata] field type is
* [MoveInstanceMetadata][google.spanner.admin.instance.v1.MoveInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful. Cancelling the operation
* sets its metadata's
* [cancel_time][google.spanner.admin.instance.v1.MoveInstanceMetadata.cancel_time]. Cancellation
* is not immediate because it involves moving any data previously moved to the target instance
* configuration back to the original instance configuration. You can use this operation to track
* the progress of the cancellation. Upon successful completion of the cancellation, the operation
* terminates with `CANCELLED` status.
*
*
If not cancelled, upon completion of the returned operation:
*
*
* The instance successfully moves to the target instance configuration. * You are
* billed for compute and storage in target instance configuration.
*
*
Authorization requires the `spanner.instances.update` permission on the resource
* [instance][google.spanner.admin.instance.v1.Instance].
*
*
For more details, see [Move an
* instance](https://cloud.google.com/spanner/docs/move-instance).
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* MoveInstanceRequest request =
* MoveInstanceRequest.newBuilder()
* .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setTargetConfig(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
* .build();
* OperationFuture future =
* instanceAdminClient.moveInstanceOperationCallable().futureCall(request);
* // Do something.
* MoveInstanceResponse response = future.get();
* }
* }
*/
public final OperationCallable
moveInstanceOperationCallable() {
return stub.moveInstanceOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moves an instance to the target instance configuration. You can use the returned [long-running
* operation][google.longrunning.Operation] to track the progress of moving the instance.
*
* `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following
* criteria:
*
*
* Is undergoing a move to a different instance configuration * Has backups * Has
* an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance
*
*
While the operation is pending:
*
*
* All other attempts to modify the instance, including changes to its compute capacity,
* are rejected. * The following database and backup admin operations are rejected:
*
*
* `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if
* default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` *
* `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup`
*
*
* Both the source and target instance configurations are subject to hourly compute and
* storage charges. * The instance might experience higher read-write latencies and a higher
* transaction abort rate. However, moving an instance doesn't cause any downtime.
*
*
The returned [long-running operation][google.longrunning.Operation] has a name of the format
* `<instance_name>/operations/<operation_id>` and can be used to track the move
* instance operation. The [metadata][google.longrunning.Operation.metadata] field type is
* [MoveInstanceMetadata][google.spanner.admin.instance.v1.MoveInstanceMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Instance][google.spanner.admin.instance.v1.Instance], if successful. Cancelling the operation
* sets its metadata's
* [cancel_time][google.spanner.admin.instance.v1.MoveInstanceMetadata.cancel_time]. Cancellation
* is not immediate because it involves moving any data previously moved to the target instance
* configuration back to the original instance configuration. You can use this operation to track
* the progress of the cancellation. Upon successful completion of the cancellation, the operation
* terminates with `CANCELLED` status.
*
*
If not cancelled, upon completion of the returned operation:
*
*
* The instance successfully moves to the target instance configuration. * You are
* billed for compute and storage in target instance configuration.
*
*
Authorization requires the `spanner.instances.update` permission on the resource
* [instance][google.spanner.admin.instance.v1.Instance].
*
*
For more details, see [Move an
* instance](https://cloud.google.com/spanner/docs/move-instance).
*
*
Sample code:
*
*
{@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 (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
* MoveInstanceRequest request =
* MoveInstanceRequest.newBuilder()
* .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setTargetConfig(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
* .build();
* ApiFuture future = instanceAdminClient.moveInstanceCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable moveInstanceCallable() {
return stub.moveInstanceCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListInstanceConfigsPagedResponse
extends AbstractPagedListResponse<
ListInstanceConfigsRequest,
ListInstanceConfigsResponse,
InstanceConfig,
ListInstanceConfigsPage,
ListInstanceConfigsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListInstanceConfigsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListInstanceConfigsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListInstanceConfigsPagedResponse(ListInstanceConfigsPage page) {
super(page, ListInstanceConfigsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListInstanceConfigsPage
extends AbstractPage<
ListInstanceConfigsRequest,
ListInstanceConfigsResponse,
InstanceConfig,
ListInstanceConfigsPage> {
private ListInstanceConfigsPage(
PageContext
context,
ListInstanceConfigsResponse response) {
super(context, response);
}
private static ListInstanceConfigsPage createEmptyPage() {
return new ListInstanceConfigsPage(null, null);
}
@Override
protected ListInstanceConfigsPage createPage(
PageContext
context,
ListInstanceConfigsResponse response) {
return new ListInstanceConfigsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListInstanceConfigsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListInstanceConfigsRequest,
ListInstanceConfigsResponse,
InstanceConfig,
ListInstanceConfigsPage,
ListInstanceConfigsFixedSizeCollection> {
private ListInstanceConfigsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListInstanceConfigsFixedSizeCollection createEmptyCollection() {
return new ListInstanceConfigsFixedSizeCollection(null, 0);
}
@Override
protected ListInstanceConfigsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListInstanceConfigsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListInstanceConfigOperationsPagedResponse
extends AbstractPagedListResponse<
ListInstanceConfigOperationsRequest,
ListInstanceConfigOperationsResponse,
Operation,
ListInstanceConfigOperationsPage,
ListInstanceConfigOperationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext<
ListInstanceConfigOperationsRequest,
ListInstanceConfigOperationsResponse,
Operation>
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListInstanceConfigOperationsPage.createEmptyPage()
.createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListInstanceConfigOperationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListInstanceConfigOperationsPagedResponse(ListInstanceConfigOperationsPage page) {
super(page, ListInstanceConfigOperationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListInstanceConfigOperationsPage
extends AbstractPage<
ListInstanceConfigOperationsRequest,
ListInstanceConfigOperationsResponse,
Operation,
ListInstanceConfigOperationsPage> {
private ListInstanceConfigOperationsPage(
PageContext<
ListInstanceConfigOperationsRequest,
ListInstanceConfigOperationsResponse,
Operation>
context,
ListInstanceConfigOperationsResponse response) {
super(context, response);
}
private static ListInstanceConfigOperationsPage createEmptyPage() {
return new ListInstanceConfigOperationsPage(null, null);
}
@Override
protected ListInstanceConfigOperationsPage createPage(
PageContext<
ListInstanceConfigOperationsRequest,
ListInstanceConfigOperationsResponse,
Operation>
context,
ListInstanceConfigOperationsResponse response) {
return new ListInstanceConfigOperationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext<
ListInstanceConfigOperationsRequest,
ListInstanceConfigOperationsResponse,
Operation>
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListInstanceConfigOperationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListInstanceConfigOperationsRequest,
ListInstanceConfigOperationsResponse,
Operation,
ListInstanceConfigOperationsPage,
ListInstanceConfigOperationsFixedSizeCollection> {
private ListInstanceConfigOperationsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListInstanceConfigOperationsFixedSizeCollection createEmptyCollection() {
return new ListInstanceConfigOperationsFixedSizeCollection(null, 0);
}
@Override
protected ListInstanceConfigOperationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListInstanceConfigOperationsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListInstancesPagedResponse
extends AbstractPagedListResponse<
ListInstancesRequest,
ListInstancesResponse,
Instance,
ListInstancesPage,
ListInstancesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListInstancesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListInstancesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListInstancesPagedResponse(ListInstancesPage page) {
super(page, ListInstancesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListInstancesPage
extends AbstractPage<
ListInstancesRequest, ListInstancesResponse, Instance, ListInstancesPage> {
private ListInstancesPage(
PageContext context,
ListInstancesResponse response) {
super(context, response);
}
private static ListInstancesPage createEmptyPage() {
return new ListInstancesPage(null, null);
}
@Override
protected ListInstancesPage createPage(
PageContext context,
ListInstancesResponse response) {
return new ListInstancesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListInstancesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListInstancesRequest,
ListInstancesResponse,
Instance,
ListInstancesPage,
ListInstancesFixedSizeCollection> {
private ListInstancesFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListInstancesFixedSizeCollection createEmptyCollection() {
return new ListInstancesFixedSizeCollection(null, 0);
}
@Override
protected ListInstancesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListInstancesFixedSizeCollection(pages, collectionSize);
}
}
public static class ListInstancePartitionsPagedResponse
extends AbstractPagedListResponse<
ListInstancePartitionsRequest,
ListInstancePartitionsResponse,
InstancePartition,
ListInstancePartitionsPage,
ListInstancePartitionsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext<
ListInstancePartitionsRequest, ListInstancePartitionsResponse, InstancePartition>
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListInstancePartitionsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListInstancePartitionsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListInstancePartitionsPagedResponse(ListInstancePartitionsPage page) {
super(page, ListInstancePartitionsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListInstancePartitionsPage
extends AbstractPage<
ListInstancePartitionsRequest,
ListInstancePartitionsResponse,
InstancePartition,
ListInstancePartitionsPage> {
private ListInstancePartitionsPage(
PageContext<
ListInstancePartitionsRequest, ListInstancePartitionsResponse, InstancePartition>
context,
ListInstancePartitionsResponse response) {
super(context, response);
}
private static ListInstancePartitionsPage createEmptyPage() {
return new ListInstancePartitionsPage(null, null);
}
@Override
protected ListInstancePartitionsPage createPage(
PageContext<
ListInstancePartitionsRequest, ListInstancePartitionsResponse, InstancePartition>
context,
ListInstancePartitionsResponse response) {
return new ListInstancePartitionsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext<
ListInstancePartitionsRequest, ListInstancePartitionsResponse, InstancePartition>
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListInstancePartitionsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListInstancePartitionsRequest,
ListInstancePartitionsResponse,
InstancePartition,
ListInstancePartitionsPage,
ListInstancePartitionsFixedSizeCollection> {
private ListInstancePartitionsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListInstancePartitionsFixedSizeCollection createEmptyCollection() {
return new ListInstancePartitionsFixedSizeCollection(null, 0);
}
@Override
protected ListInstancePartitionsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListInstancePartitionsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListInstancePartitionOperationsPagedResponse
extends AbstractPagedListResponse<
ListInstancePartitionOperationsRequest,
ListInstancePartitionOperationsResponse,
Operation,
ListInstancePartitionOperationsPage,
ListInstancePartitionOperationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext<
ListInstancePartitionOperationsRequest,
ListInstancePartitionOperationsResponse,
Operation>
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListInstancePartitionOperationsPage.createEmptyPage()
.createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListInstancePartitionOperationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListInstancePartitionOperationsPagedResponse(ListInstancePartitionOperationsPage page) {
super(page, ListInstancePartitionOperationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListInstancePartitionOperationsPage
extends AbstractPage<
ListInstancePartitionOperationsRequest,
ListInstancePartitionOperationsResponse,
Operation,
ListInstancePartitionOperationsPage> {
private ListInstancePartitionOperationsPage(
PageContext<
ListInstancePartitionOperationsRequest,
ListInstancePartitionOperationsResponse,
Operation>
context,
ListInstancePartitionOperationsResponse response) {
super(context, response);
}
private static ListInstancePartitionOperationsPage createEmptyPage() {
return new ListInstancePartitionOperationsPage(null, null);
}
@Override
protected ListInstancePartitionOperationsPage createPage(
PageContext<
ListInstancePartitionOperationsRequest,
ListInstancePartitionOperationsResponse,
Operation>
context,
ListInstancePartitionOperationsResponse response) {
return new ListInstancePartitionOperationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext<
ListInstancePartitionOperationsRequest,
ListInstancePartitionOperationsResponse,
Operation>
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListInstancePartitionOperationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListInstancePartitionOperationsRequest,
ListInstancePartitionOperationsResponse,
Operation,
ListInstancePartitionOperationsPage,
ListInstancePartitionOperationsFixedSizeCollection> {
private ListInstancePartitionOperationsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListInstancePartitionOperationsFixedSizeCollection createEmptyCollection() {
return new ListInstancePartitionOperationsFixedSizeCollection(null, 0);
}
@Override
protected ListInstancePartitionOperationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListInstancePartitionOperationsFixedSizeCollection(pages, collectionSize);
}
}
}