Class DatabaseCenterClient (0.1.0)

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

Service Description: DatabaseCenter contains methods to query fleet view for database 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 (DatabaseCenterClient databaseCenterClient = DatabaseCenterClient.create()) {
   QueryProductsRequest request =
       QueryProductsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Product element : databaseCenterClient.queryProducts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Note: close() needs to be called on the DatabaseCenterClient 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
QueryProducts	QueryProducts provides a list of all possible products which can be used to filter database resources.	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryProducts(QueryProductsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryProductsPagedCallable() queryProductsCallable()

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 DatabaseCenterSettings 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
 DatabaseCenterSettings databaseCenterSettings =
     DatabaseCenterSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DatabaseCenterClient databaseCenterClient = DatabaseCenterClient.create(databaseCenterSettings);
 

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
 DatabaseCenterSettings databaseCenterSettings =
     DatabaseCenterSettings.newBuilder().setEndpoint(myEndpoint).build();
 DatabaseCenterClient databaseCenterClient = DatabaseCenterClient.create(databaseCenterSettings);
 

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
 DatabaseCenterSettings databaseCenterSettings =
     DatabaseCenterSettings.newHttpJsonBuilder().build();
 DatabaseCenterClient databaseCenterClient = DatabaseCenterClient.create(databaseCenterSettings);
 

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

Inheritance

java.lang.Object > DatabaseCenterClient

Static Methods

create()

public static final DatabaseCenterClient create()

Constructs an instance of DatabaseCenterClient with default settings.

Returns
Type	Description
DatabaseCenterClient

Exceptions
Type	Description
IOException

create(DatabaseCenterSettings settings)

public static final DatabaseCenterClient create(DatabaseCenterSettings settings)

Constructs an instance of DatabaseCenterClient, 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	DatabaseCenterSettings

Returns
Type	Description
DatabaseCenterClient

Exceptions
Type	Description
IOException

create(DatabaseCenterStub stub)

public static final DatabaseCenterClient create(DatabaseCenterStub stub)

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

Parameter
Name	Description
stub	DatabaseCenterStub

Returns
Type	Description
DatabaseCenterClient

Constructors

DatabaseCenterClient(DatabaseCenterSettings settings)

protected DatabaseCenterClient(DatabaseCenterSettings settings)

Constructs an instance of DatabaseCenterClient, 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	DatabaseCenterSettings

DatabaseCenterClient(DatabaseCenterStub stub)

protected DatabaseCenterClient(DatabaseCenterStub stub)

Parameter
Name	Description
stub	DatabaseCenterStub

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

getSettings()

public final DatabaseCenterSettings getSettings()

Returns
Type	Description
DatabaseCenterSettings

getStub()

public DatabaseCenterStub getStub()

Returns
Type	Description
DatabaseCenterStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

queryProducts(QueryProductsRequest request)

public final DatabaseCenterClient.QueryProductsPagedResponse queryProducts(QueryProductsRequest request)

QueryProducts provides a list of all possible products which can be used to filter database resources.

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 (DatabaseCenterClient databaseCenterClient = DatabaseCenterClient.create()) {
   QueryProductsRequest request =
       QueryProductsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Product element : databaseCenterClient.queryProducts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
DatabaseCenterClient.QueryProductsPagedResponse

queryProductsCallable()

public final UnaryCallable<QueryProductsRequest,QueryProductsResponse> queryProductsCallable()

QueryProducts provides a list of all possible products which can be used to filter database resources.

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 (DatabaseCenterClient databaseCenterClient = DatabaseCenterClient.create()) {
   QueryProductsRequest request =
       QueryProductsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     QueryProductsResponse response = databaseCenterClient.queryProductsCallable().call(request);
     for (Product element : response.getProductsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<QueryProductsRequest,QueryProductsResponse>

queryProductsPagedCallable()

public final UnaryCallable<QueryProductsRequest,DatabaseCenterClient.QueryProductsPagedResponse> queryProductsPagedCallable()

QueryProducts provides a list of all possible products which can be used to filter database resources.

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 (DatabaseCenterClient databaseCenterClient = DatabaseCenterClient.create()) {
   QueryProductsRequest request =
       QueryProductsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Product> future =
       databaseCenterClient.queryProductsPagedCallable().futureCall(request);
   // Do something.
   for (Product element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<QueryProductsRequest,QueryProductsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()