public class AlloyDBAdminClient implements BackgroundResource
Service Description: Service describing handlers for resources
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
Cluster response = alloyDBAdminClient.getCluster(name);
}
Note: close() needs to be called on the AlloyDBAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AlloyDBAdminSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AlloyDBAdminSettings alloyDBAdminSettings =
AlloyDBAdminSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create(alloyDBAdminSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AlloyDBAdminSettings alloyDBAdminSettings =
AlloyDBAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create(alloyDBAdminSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AlloyDBAdminSettings alloyDBAdminSettings = AlloyDBAdminSettings.newHttpJsonBuilder().build();
AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create(alloyDBAdminSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final AlloyDBAdminClient create()
Constructs an instance of AlloyDBAdminClient with default settings.
Returns | |
---|---|
Type | Description |
AlloyDBAdminClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(AlloyDBAdminSettings settings)
public static final AlloyDBAdminClient create(AlloyDBAdminSettings settings)
Constructs an instance of AlloyDBAdminClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings |
AlloyDBAdminSettings |
Returns | |
---|---|
Type | Description |
AlloyDBAdminClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(AlloyDBAdminStub stub)
public static final AlloyDBAdminClient create(AlloyDBAdminStub stub)
Constructs an instance of AlloyDBAdminClient, using the given stub for making calls. This is for advanced usage - prefer using create(AlloyDBAdminSettings).
Parameter | |
---|---|
Name | Description |
stub |
AlloyDBAdminStub |
Returns | |
---|---|
Type | Description |
AlloyDBAdminClient |
Constructors
AlloyDBAdminClient(AlloyDBAdminSettings settings)
protected AlloyDBAdminClient(AlloyDBAdminSettings settings)
Constructs an instance of AlloyDBAdminClient, 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.
Parameter | |
---|---|
Name | Description |
settings |
AlloyDBAdminSettings |
AlloyDBAdminClient(AlloyDBAdminStub stub)
protected AlloyDBAdminClient(AlloyDBAdminStub stub)
Parameter | |
---|---|
Name | Description |
stub |
AlloyDBAdminStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
batchCreateInstancesAsync(BatchCreateInstancesRequest request)
public final OperationFuture<BatchCreateInstancesResponse,OperationMetadata> batchCreateInstancesAsync(BatchCreateInstancesRequest request)
Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
BatchCreateInstancesRequest request =
BatchCreateInstancesRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setRequests(CreateInstanceRequests.newBuilder().build())
.setRequestId("requestId693933066")
.build();
BatchCreateInstancesResponse response =
alloyDBAdminClient.batchCreateInstancesAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
BatchCreateInstancesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<BatchCreateInstancesResponse,OperationMetadata> |
batchCreateInstancesCallable()
public final UnaryCallable<BatchCreateInstancesRequest,Operation> batchCreateInstancesCallable()
Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
BatchCreateInstancesRequest request =
BatchCreateInstancesRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setRequests(CreateInstanceRequests.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
alloyDBAdminClient.batchCreateInstancesCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<BatchCreateInstancesRequest,Operation> |
batchCreateInstancesOperationCallable()
public final OperationCallable<BatchCreateInstancesRequest,BatchCreateInstancesResponse,OperationMetadata> batchCreateInstancesOperationCallable()
Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
BatchCreateInstancesRequest request =
BatchCreateInstancesRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setRequests(CreateInstanceRequests.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<BatchCreateInstancesResponse, OperationMetadata> future =
alloyDBAdminClient.batchCreateInstancesOperationCallable().futureCall(request);
// Do something.
BatchCreateInstancesResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<BatchCreateInstancesRequest,BatchCreateInstancesResponse,OperationMetadata> |
close()
public final void close()
createBackupAsync(CreateBackupRequest request)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(CreateBackupRequest request)
Creates a new Backup in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBackupId("backupId2121930365")
.setBackup(Backup.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
Backup response = alloyDBAdminClient.createBackupAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateBackupRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupAsync(LocationName parent, Backup backup, String backupId)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(LocationName parent, Backup backup, String backupId)
Creates a new Backup in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Backup backup = Backup.newBuilder().build();
String backupId = "backupId2121930365";
Backup response = alloyDBAdminClient.createBackupAsync(parent, backup, backupId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. Value for parent. |
backup |
Backup Required. The resource being created |
backupId |
String Required. ID of the requesting object. |
Returns | |
---|---|
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupAsync(String parent, Backup backup, String backupId)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(String parent, Backup backup, String backupId)
Creates a new Backup in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Backup backup = Backup.newBuilder().build();
String backupId = "backupId2121930365";
Backup response = alloyDBAdminClient.createBackupAsync(parent, backup, backupId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. Value for parent. |
backup |
Backup Required. The resource being created |
backupId |
String Required. ID of the requesting object. |
Returns | |
---|---|
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupCallable()
public final UnaryCallable<CreateBackupRequest,Operation> createBackupCallable()
Creates a new Backup in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBackupId("backupId2121930365")
.setBackup(Backup.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
ApiFuture<Operation> future = alloyDBAdminClient.createBackupCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateBackupRequest,Operation> |
createBackupOperationCallable()
public final OperationCallable<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationCallable()
Creates a new Backup in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBackupId("backupId2121930365")
.setBackup(Backup.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
OperationFuture<Backup, OperationMetadata> future =
alloyDBAdminClient.createBackupOperationCallable().futureCall(request);
// Do something.
Backup response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateBackupRequest,Backup,OperationMetadata> |
createClusterAsync(CreateClusterRequest request)
public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(CreateClusterRequest request)
Creates a new Cluster in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateClusterRequest request =
CreateClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setClusterId("clusterId561939637")
.setCluster(Cluster.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
Cluster response = alloyDBAdminClient.createClusterAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,OperationMetadata> |
createClusterAsync(LocationName parent, Cluster cluster, String clusterId)
public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(LocationName parent, Cluster cluster, String clusterId)
Creates a new Cluster in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Cluster cluster = Cluster.newBuilder().build();
String clusterId = "clusterId561939637";
Cluster response = alloyDBAdminClient.createClusterAsync(parent, cluster, clusterId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. |
cluster |
Cluster Required. The resource being created |
clusterId |
String Required. ID of the requesting object. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,OperationMetadata> |
createClusterAsync(String parent, Cluster cluster, String clusterId)
public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(String parent, Cluster cluster, String clusterId)
Creates a new Cluster in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Cluster cluster = Cluster.newBuilder().build();
String clusterId = "clusterId561939637";
Cluster response = alloyDBAdminClient.createClusterAsync(parent, cluster, clusterId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. |
cluster |
Cluster Required. The resource being created |
clusterId |
String Required. ID of the requesting object. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,OperationMetadata> |
createClusterCallable()
public final UnaryCallable<CreateClusterRequest,Operation> createClusterCallable()
Creates a new Cluster in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateClusterRequest request =
CreateClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setClusterId("clusterId561939637")
.setCluster(Cluster.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
ApiFuture<Operation> future = alloyDBAdminClient.createClusterCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateClusterRequest,Operation> |
createClusterOperationCallable()
public final OperationCallable<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationCallable()
Creates a new Cluster in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateClusterRequest request =
CreateClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setClusterId("clusterId561939637")
.setCluster(Cluster.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
OperationFuture<Cluster, OperationMetadata> future =
alloyDBAdminClient.createClusterOperationCallable().futureCall(request);
// Do something.
Cluster response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateClusterRequest,Cluster,OperationMetadata> |
createInstanceAsync(ClusterName parent, Instance instance, String instanceId)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(ClusterName parent, Instance instance, String instanceId)
Creates a new Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
Instance instance = Instance.newBuilder().build();
String instanceId = "instanceId902024336";
Instance response =
alloyDBAdminClient.createInstanceAsync(parent, instance, instanceId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
ClusterName Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. |
instance |
Instance Required. The resource being created |
instanceId |
String Required. ID of the requesting object. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceAsync(CreateInstanceRequest request)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(CreateInstanceRequest request)
Creates a new Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
Instance response = alloyDBAdminClient.createInstanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceAsync(String parent, Instance instance, String instanceId)
public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(String parent, Instance instance, String instanceId)
Creates a new Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
Instance instance = Instance.newBuilder().build();
String instanceId = "instanceId902024336";
Instance response =
alloyDBAdminClient.createInstanceAsync(parent, instance, instanceId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. |
instance |
Instance Required. The resource being created |
instanceId |
String Required. ID of the requesting object. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createInstanceCallable()
public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()
Creates a new Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
ApiFuture<Operation> future = alloyDBAdminClient.createInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateInstanceRequest,Operation> |
createInstanceOperationCallable()
public final OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationCallable()
Creates a new Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateInstanceRequest request =
CreateInstanceRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
OperationFuture<Instance, OperationMetadata> future =
alloyDBAdminClient.createInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> |
createSecondaryClusterAsync(CreateSecondaryClusterRequest request)
public final OperationFuture<Cluster,OperationMetadata> createSecondaryClusterAsync(CreateSecondaryClusterRequest request)
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateSecondaryClusterRequest request =
CreateSecondaryClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setClusterId("clusterId561939637")
.setCluster(Cluster.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
Cluster response = alloyDBAdminClient.createSecondaryClusterAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateSecondaryClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,OperationMetadata> |
createSecondaryClusterAsync(LocationName parent, Cluster cluster, String clusterId)
public final OperationFuture<Cluster,OperationMetadata> createSecondaryClusterAsync(LocationName parent, Cluster cluster, String clusterId)
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Cluster cluster = Cluster.newBuilder().build();
String clusterId = "clusterId561939637";
Cluster response =
alloyDBAdminClient.createSecondaryClusterAsync(parent, cluster, clusterId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. The name of the parent resource (the primary cluster). For the required format, see the comment on the Cluster.name field. |
cluster |
Cluster Required. Configuration of the requesting object (the secondary cluster). |
clusterId |
String Required. ID of the requesting object (the secondary cluster). |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,OperationMetadata> |
createSecondaryClusterAsync(String parent, Cluster cluster, String clusterId)
public final OperationFuture<Cluster,OperationMetadata> createSecondaryClusterAsync(String parent, Cluster cluster, String clusterId)
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Cluster cluster = Cluster.newBuilder().build();
String clusterId = "clusterId561939637";
Cluster response =
alloyDBAdminClient.createSecondaryClusterAsync(parent, cluster, clusterId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The name of the parent resource (the primary cluster). For the required format, see the comment on the Cluster.name field. |
cluster |
Cluster Required. Configuration of the requesting object (the secondary cluster). |
clusterId |
String Required. ID of the requesting object (the secondary cluster). |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,OperationMetadata> |
createSecondaryClusterCallable()
public final UnaryCallable<CreateSecondaryClusterRequest,Operation> createSecondaryClusterCallable()
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateSecondaryClusterRequest request =
CreateSecondaryClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setClusterId("clusterId561939637")
.setCluster(Cluster.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
ApiFuture<Operation> future =
alloyDBAdminClient.createSecondaryClusterCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateSecondaryClusterRequest,Operation> |
createSecondaryClusterOperationCallable()
public final OperationCallable<CreateSecondaryClusterRequest,Cluster,OperationMetadata> createSecondaryClusterOperationCallable()
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateSecondaryClusterRequest request =
CreateSecondaryClusterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setClusterId("clusterId561939637")
.setCluster(Cluster.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
OperationFuture<Cluster, OperationMetadata> future =
alloyDBAdminClient.createSecondaryClusterOperationCallable().futureCall(request);
// Do something.
Cluster response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateSecondaryClusterRequest,Cluster,OperationMetadata> |
createSecondaryInstanceAsync(ClusterName parent, Instance instance, String instanceId)
public final OperationFuture<Instance,OperationMetadata> createSecondaryInstanceAsync(ClusterName parent, Instance instance, String instanceId)
Creates a new SECONDARY Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
Instance instance = Instance.newBuilder().build();
String instanceId = "instanceId902024336";
Instance response =
alloyDBAdminClient.createSecondaryInstanceAsync(parent, instance, instanceId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
ClusterName Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. |
instance |
Instance Required. The resource being created |
instanceId |
String Required. ID of the requesting object. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createSecondaryInstanceAsync(CreateSecondaryInstanceRequest request)
public final OperationFuture<Instance,OperationMetadata> createSecondaryInstanceAsync(CreateSecondaryInstanceRequest request)
Creates a new SECONDARY Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateSecondaryInstanceRequest request =
CreateSecondaryInstanceRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
Instance response = alloyDBAdminClient.createSecondaryInstanceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateSecondaryInstanceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createSecondaryInstanceAsync(String parent, Instance instance, String instanceId)
public final OperationFuture<Instance,OperationMetadata> createSecondaryInstanceAsync(String parent, Instance instance, String instanceId)
Creates a new SECONDARY Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
Instance instance = Instance.newBuilder().build();
String instanceId = "instanceId902024336";
Instance response =
alloyDBAdminClient.createSecondaryInstanceAsync(parent, instance, instanceId).get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. |
instance |
Instance Required. The resource being created |
instanceId |
String Required. ID of the requesting object. |
Returns | |
---|---|
Type | Description |
OperationFuture<Instance,OperationMetadata> |
createSecondaryInstanceCallable()
public final UnaryCallable<CreateSecondaryInstanceRequest,Operation> createSecondaryInstanceCallable()
Creates a new SECONDARY Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateSecondaryInstanceRequest request =
CreateSecondaryInstanceRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
ApiFuture<Operation> future =
alloyDBAdminClient.createSecondaryInstanceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateSecondaryInstanceRequest,Operation> |
createSecondaryInstanceOperationCallable()
public final OperationCallable<CreateSecondaryInstanceRequest,Instance,OperationMetadata> createSecondaryInstanceOperationCallable()
Creates a new SECONDARY Instance in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
CreateSecondaryInstanceRequest request =
CreateSecondaryInstanceRequest.newBuilder()
.setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setInstanceId("instanceId902024336")
.setInstance(Instance.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.build();
OperationFuture<Instance, OperationMetadata> future =
alloyDBAdminClient.createSecondaryInstanceOperationCallable().futureCall(request);
// Do something.
Instance response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateSecondaryInstanceRequest,Instance,OperationMetadata> |
deleteBackupAsync(BackupName name)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(BackupName name)
Deletes a single Backup.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]");
alloyDBAdminClient.deleteBackupAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
BackupName Required. Name of the resource. For the required format, see the comment on the Backup.name field. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupAsync(DeleteBackupRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(DeleteBackupRequest request)
Deletes a single Backup.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
alloyDBAdminClient.deleteBackupAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteBackupRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(String name)
Deletes a single Backup.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
String name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString();
alloyDBAdminClient.deleteBackupAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Name of the resource. For the required format, see the comment on the Backup.name field. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupCallable()
public final UnaryCallable<DeleteBackupRequest,Operation> deleteBackupCallable()
Deletes a single Backup.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
ApiFuture<Operation> future = alloyDBAdminClient.deleteBackupCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteBackupRequest,Operation> |
deleteBackupOperationCallable()
public final OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationCallable()
Deletes a single Backup.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
OperationFuture<Empty, OperationMetadata> future =
alloyDBAdminClient.deleteBackupOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> |
deleteClusterAsync(ClusterName name)
public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(ClusterName name)
Deletes a single Cluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
alloyDBAdminClient.deleteClusterAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
ClusterName Required. The name of the resource. For the required format, see the comment on the Cluster.name field. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteClusterAsync(DeleteClusterRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(DeleteClusterRequest request)
Deletes a single Cluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
DeleteClusterRequest request =
DeleteClusterRequest.newBuilder()
.setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setRequestId("requestId693933066")
.setEtag("etag3123477")
.setValidateOnly(true)
.setForce(true)
.build();
alloyDBAdminClient.deleteClusterAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteClusterAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteClusterAsync(String name)
Deletes a single Cluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
String name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
alloyDBAdminClient.deleteClusterAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the resource. For the required format, see the comment on the Cluster.name field. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteClusterCallable()
public final UnaryCallable<DeleteClusterRequest,Operation> deleteClusterCallable()
Deletes a single Cluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
DeleteClusterRequest request =
DeleteClusterRequest.newBuilder()
.setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setRequestId("requestId693933066")
.setEtag("etag3123477")
.setValidateOnly(true)
.setForce(true)
.build();
ApiFuture<Operation> future = alloyDBAdminClient.deleteClusterCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteClusterRequest,Operation> |
deleteClusterOperationCallable()
public final OperationCallable<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationCallable()
Deletes a single Cluster.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
DeleteClusterRequest request =
DeleteClusterRequest.newBuilder()
.setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
.setRequestId("requestId693933066")
.setEtag("etag3123477")
.setValidateOnly(true)
.setForce(true)
.build();
OperationFuture<Empty, OperationMetadata> future =
alloyDBAdminClient.deleteClusterOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteClusterRequest,Empty,OperationMetadata> |
deleteInstanceAsync(DeleteInstanceRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request)
Deletes a single Instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AlloyDBAdminClient alloyDBAdminClient = AlloyDBAdminClient.create()) {
DeleteInstanceRequest request =
DeleteInstanceRequest.newBuilder()
.setName(
InstanceName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]"