Package com.google.area120.tables.v1alpha (0.23.0)

A client to Area120 Tables API

The interfaces provided are listed below, along with usage samples.

TablesServiceClient

Service Description: The Tables Service provides an API for reading and updating tables. It defines the following resource model:

- The API has a collection of Table resources, named tables/*

- Each Table has a collection of Row resources, named tables/*/rows/*

- The API has a collection of Workspace resources, named workspaces/*.

Sample for TablesServiceClient:


 // 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 (TablesServiceClient tablesServiceClient = TablesServiceClient.create()) {
   TableName name = TableName.of("[TABLE]");
   Table response = tablesServiceClient.getTable(name);
 }

Classes

TablesServiceClient

Service Description: The Tables Service provides an API for reading and updating tables. It defines the following resource model:

- The API has a collection of Table resources, named tables/*

- Each Table has a collection of Row resources, named tables/*/rows/*

- The API has a collection of Workspace resources, named workspaces/*.

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 (TablesServiceClient tablesServiceClient = TablesServiceClient.create()) {
   TableName name = TableName.of("[TABLE]");
   Table response = tablesServiceClient.getTable(name);
 }

Note: close() needs to be called on the TablesServiceClient 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:

  1. 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.
  2. 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.
  3. 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 TablesServiceSettings 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
 TablesServiceSettings tablesServiceSettings =
     TablesServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TablesServiceClient tablesServiceClient = TablesServiceClient.create(tablesServiceSettings);

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
 TablesServiceSettings tablesServiceSettings =
     TablesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TablesServiceClient tablesServiceClient = TablesServiceClient.create(tablesServiceSettings);

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
 TablesServiceSettings tablesServiceSettings =
     TablesServiceSettings.newHttpJsonBuilder().build();
 TablesServiceClient tablesServiceClient = TablesServiceClient.create(tablesServiceSettings);

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

TablesServiceClient.ListRowsFixedSizeCollection

TablesServiceClient.ListRowsPage

TablesServiceClient.ListRowsPagedResponse

TablesServiceClient.ListTablesFixedSizeCollection

TablesServiceClient.ListTablesPage

TablesServiceClient.ListTablesPagedResponse

TablesServiceClient.ListWorkspacesFixedSizeCollection

TablesServiceClient.ListWorkspacesPage

TablesServiceClient.ListWorkspacesPagedResponse

TablesServiceSettings

Settings class to configure an instance of TablesServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (area120tables.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getTable to 30 seconds:


 // 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
 TablesServiceSettings.Builder tablesServiceSettingsBuilder = TablesServiceSettings.newBuilder();
 tablesServiceSettingsBuilder
     .getTableSettings()
     .setRetrySettings(
         tablesServiceSettingsBuilder
             .getTableSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TablesServiceSettings tablesServiceSettings = tablesServiceSettingsBuilder.build();

TablesServiceSettings.Builder

Builder for TablesServiceSettings.