com.google.cloud.alloydb.v1

Class AlloyDBCSQLAdminClient

java.lang.Object

com.google.cloud.alloydb.v1.AlloyDBCSQLAdminClient

All Implemented Interfaces:

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

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

Service Description: Service for interactions with CloudSQL.

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 (AlloyDBCSQLAdminClient alloyDBCSQLAdminClient = AlloyDBCSQLAdminClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = alloyDBCSQLAdminClient.getLocation(request);
 }
 

Note: close() needs to be called on the AlloyDBCSQLAdminClient 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
RestoreFromCloudSQL	Restores an AlloyDB cluster from a CloudSQL resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. restoreFromCloudSQLAsync(RestoreFromCloudSQLRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. restoreFromCloudSQLAsync(LocationName parent, String clusterId) restoreFromCloudSQLAsync(String parent, String clusterId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. restoreFromCloudSQLOperationCallable() restoreFromCloudSQLCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 AlloyDBCSQLAdminSettings 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
 AlloyDBCSQLAdminSettings alloyDBCSQLAdminSettings =
     AlloyDBCSQLAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AlloyDBCSQLAdminClient alloyDBCSQLAdminClient =
     AlloyDBCSQLAdminClient.create(alloyDBCSQLAdminSettings);
 

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
 AlloyDBCSQLAdminSettings alloyDBCSQLAdminSettings =
     AlloyDBCSQLAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 AlloyDBCSQLAdminClient alloyDBCSQLAdminClient =
     AlloyDBCSQLAdminClient.create(alloyDBCSQLAdminSettings);
 

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
 AlloyDBCSQLAdminSettings alloyDBCSQLAdminSettings =
     AlloyDBCSQLAdminSettings.newHttpJsonBuilder().build();
 AlloyDBCSQLAdminClient alloyDBCSQLAdminClient =
     AlloyDBCSQLAdminClient.create(alloyDBCSQLAdminSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlloyDBCSQLAdminClient.ListLocationsFixedSizeCollection
static class	AlloyDBCSQLAdminClient.ListLocationsPage
static class	AlloyDBCSQLAdminClient.ListLocationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlloyDBCSQLAdminClient(AlloyDBCSQLAdminSettings settings) Constructs an instance of AlloyDBCSQLAdminClient, using the given settings.
protected	AlloyDBCSQLAdminClient(AlloyDBCSQLAdminStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static AlloyDBCSQLAdminClient	create() Constructs an instance of AlloyDBCSQLAdminClient with default settings.
static AlloyDBCSQLAdminClient	create(AlloyDBCSQLAdminSettings settings) Constructs an instance of AlloyDBCSQLAdminClient, using the given settings.
static AlloyDBCSQLAdminClient	create(AlloyDBCSQLAdminStub stub) Constructs an instance of AlloyDBCSQLAdminClient, using the given stub for making calls.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.cloud.location.Location	getLocation(com.google.cloud.location.GetLocationRequest request) Gets information about a location.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationCallable() Gets information about a location.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
AlloyDBCSQLAdminSettings	getSettings()
AlloyDBCSQLAdminStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
AlloyDBCSQLAdminClient.ListLocationsPagedResponse	listLocations(com.google.cloud.location.ListLocationsRequest request) Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>	listLocationsCallable() Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,AlloyDBCSQLAdminClient.ListLocationsPagedResponse>	listLocationsPagedCallable() Lists information about the supported locations for this service.
com.google.api.gax.longrunning.OperationFuture<Cluster,OperationMetadata>	restoreFromCloudSQLAsync(LocationName parent, String clusterId) Restores an AlloyDB cluster from a CloudSQL resource.
com.google.api.gax.longrunning.OperationFuture<Cluster,OperationMetadata>	restoreFromCloudSQLAsync(RestoreFromCloudSQLRequest request) Restores an AlloyDB cluster from a CloudSQL resource.
com.google.api.gax.longrunning.OperationFuture<Cluster,OperationMetadata>	restoreFromCloudSQLAsync(String parent, String clusterId) Restores an AlloyDB cluster from a CloudSQL resource.
com.google.api.gax.rpc.UnaryCallable<RestoreFromCloudSQLRequest,com.google.longrunning.Operation>	restoreFromCloudSQLCallable() Restores an AlloyDB cluster from a CloudSQL resource.
com.google.api.gax.rpc.OperationCallable<RestoreFromCloudSQLRequest,Cluster,OperationMetadata>	restoreFromCloudSQLOperationCallable() Restores an AlloyDB cluster from a CloudSQL resource.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlloyDBCSQLAdminClient

protected AlloyDBCSQLAdminClient(AlloyDBCSQLAdminSettings settings)
                          throws IOException

Constructs an instance of AlloyDBCSQLAdminClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

AlloyDBCSQLAdminClient

protected AlloyDBCSQLAdminClient(AlloyDBCSQLAdminStub stub)

Method Detail

create

public static final AlloyDBCSQLAdminClient create()
                                           throws IOException

Constructs an instance of AlloyDBCSQLAdminClient with default settings.

Throws:

IOException

create

public static final AlloyDBCSQLAdminClient create(AlloyDBCSQLAdminSettings settings)
                                           throws IOException

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

Throws:

IOException

create

public static final AlloyDBCSQLAdminClient create(AlloyDBCSQLAdminStub stub)

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

getSettings

public final AlloyDBCSQLAdminSettings getSettings()

getStub

public AlloyDBCSQLAdminStub getStub()

getOperationsClient

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

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

getHttpJsonOperationsClient

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

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

restoreFromCloudSQLAsync

public final com.google.api.gax.longrunning.OperationFuture<Cluster,OperationMetadata> restoreFromCloudSQLAsync(LocationName parent,
                                                                                                                String clusterId)

Restores an AlloyDB cluster from a CloudSQL resource.

Sample code:

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

Parameters:

parent - Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.

clusterId - Required. ID of the requesting object.

Throws:

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

restoreFromCloudSQLAsync

public final com.google.api.gax.longrunning.OperationFuture<Cluster,OperationMetadata> restoreFromCloudSQLAsync(String parent,
                                                                                                                String clusterId)

Restores an AlloyDB cluster from a CloudSQL resource.

Sample code:

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

Parameters:

parent - Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.

clusterId - Required. ID of the requesting object.

Throws:

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

restoreFromCloudSQLAsync

public final com.google.api.gax.longrunning.OperationFuture<Cluster,OperationMetadata> restoreFromCloudSQLAsync(RestoreFromCloudSQLRequest request)

Restores an AlloyDB cluster from a CloudSQL resource.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlloyDBCSQLAdminClient alloyDBCSQLAdminClient = AlloyDBCSQLAdminClient.create()) {
   RestoreFromCloudSQLRequest request =
       RestoreFromCloudSQLRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .build();
   Cluster response = alloyDBCSQLAdminClient.restoreFromCloudSQLAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

restoreFromCloudSQLOperationCallable

public final com.google.api.gax.rpc.OperationCallable<RestoreFromCloudSQLRequest,Cluster,OperationMetadata> restoreFromCloudSQLOperationCallable()

Restores an AlloyDB cluster from a CloudSQL resource.

Sample code:

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

restoreFromCloudSQLCallable

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

Restores an AlloyDB cluster from a CloudSQL resource.

Sample code:

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

listLocations

public final AlloyDBCSQLAdminClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (AlloyDBCSQLAdminClient alloyDBCSQLAdminClient = AlloyDBCSQLAdminClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : alloyDBCSQLAdminClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

listLocationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,AlloyDBCSQLAdminClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (AlloyDBCSQLAdminClient alloyDBCSQLAdminClient = AlloyDBCSQLAdminClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       alloyDBCSQLAdminClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listLocationsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (AlloyDBCSQLAdminClient alloyDBCSQLAdminClient = AlloyDBCSQLAdminClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         alloyDBCSQLAdminClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getLocation

public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)

Gets information about a 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 (AlloyDBCSQLAdminClient alloyDBCSQLAdminClient = AlloyDBCSQLAdminClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = alloyDBCSQLAdminClient.getLocation(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

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

getLocationCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()

Gets information about a 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 (AlloyDBCSQLAdminClient alloyDBCSQLAdminClient = AlloyDBCSQLAdminClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = alloyDBCSQLAdminClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException