Class AlloyDBCSQLAdminClient (0.56.0)

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.

Inheritance

java.lang.Object > AlloyDBCSQLAdminClient

Static Methods

create()

public static final AlloyDBCSQLAdminClient create()

Constructs an instance of AlloyDBCSQLAdminClient with default settings.

Returns
Type	Description
`AlloyDBCSQLAdminClient`

Exceptions
Type	Description
`IOException`

create(AlloyDBCSQLAdminSettings settings)

public static final AlloyDBCSQLAdminClient create(AlloyDBCSQLAdminSettings settings)

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.

Parameter
Name	Description
`settings`	`AlloyDBCSQLAdminSettings`

Returns
Type	Description
`AlloyDBCSQLAdminClient`

Exceptions
Type	Description
`IOException`

create(AlloyDBCSQLAdminStub stub)

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).

Parameter
Name	Description
`stub`	`AlloyDBCSQLAdminStub`

Returns
Type	Description
`AlloyDBCSQLAdminClient`

Constructors

AlloyDBCSQLAdminClient(AlloyDBCSQLAdminSettings settings)

protected AlloyDBCSQLAdminClient(AlloyDBCSQLAdminSettings settings)

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.

Parameter
Name	Description
`settings`	`AlloyDBCSQLAdminSettings`

AlloyDBCSQLAdminClient(AlloyDBCSQLAdminStub stub)

protected AlloyDBCSQLAdminClient(AlloyDBCSQLAdminStub stub)

Parameter
Name	Description
`stub`	`AlloyDBCSQLAdminStub`

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`

close()

public final void close()

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns
Type	Description
`OperationsClient`

getLocation(GetLocationRequest request)

public final Location getLocation(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);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,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();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type	Description
`OperationsClient`

getSettings()

public final AlloyDBCSQLAdminSettings getSettings()

Returns
Type	Description
`AlloyDBCSQLAdminSettings`

getStub()

public AlloyDBCSQLAdminStub getStub()

Returns
Type	Description
`AlloyDBCSQLAdminStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listLocations(ListLocationsRequest request)

public final AlloyDBCSQLAdminClient.ListLocationsPagedResponse listLocations(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);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AlloyDBCSQLAdminClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<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);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

restoreFromCloudSQLAsync(LocationName parent, String clusterId)

public final 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
Name	Description
`parent`	`LocationName` Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
`clusterId`	`String` Required. ID of the requesting object.

Returns
Type	Description
`OperationFuture<Cluster,OperationMetadata>`

restoreFromCloudSQLAsync(RestoreFromCloudSQLRequest request)

public final 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();
 }

Parameter
Name	Description
`request`	`RestoreFromCloudSQLRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Cluster,OperationMetadata>`

restoreFromCloudSQLAsync(String parent, String clusterId)

public final 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
Name	Description
`parent`	`String` Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
`clusterId`	`String` Required. ID of the requesting object.

Returns
Type	Description
`OperationFuture<Cluster,OperationMetadata>`

restoreFromCloudSQLCallable()

public final UnaryCallable<RestoreFromCloudSQLRequest,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();
 }

Returns
Type	Description
`UnaryCallable<RestoreFromCloudSQLRequest,Operation>`

restoreFromCloudSQLOperationCallable()

public final 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();
 }

Returns
Type	Description
`OperationCallable<RestoreFromCloudSQLRequest,Cluster,OperationMetadata>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class AlloyDBCSQLAdminClient (0.56.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(AlloyDBCSQLAdminSettings settings)

create(AlloyDBCSQLAdminStub stub)

Constructors

AlloyDBCSQLAdminClient(AlloyDBCSQLAdminSettings settings)

AlloyDBCSQLAdminClient(AlloyDBCSQLAdminStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getHttpJsonOperationsClient()

getLocation(GetLocationRequest request)

getLocationCallable()

getOperationsClient()

getSettings()

getStub()

isShutdown()

isTerminated()

listLocations(ListLocationsRequest request)

listLocationsCallable()

listLocationsPagedCallable()

restoreFromCloudSQLAsync(LocationName parent, String clusterId)

restoreFromCloudSQLAsync(RestoreFromCloudSQLRequest request)

restoreFromCloudSQLAsync(String parent, String clusterId)

restoreFromCloudSQLCallable()

restoreFromCloudSQLOperationCallable()

shutdown()

shutdownNow()

Class AlloyDBCSQLAdminClient (0.56.0)