Package com.google.cloud.bigquery.connection.v1beta1 (2.29.0)

A client to BigQuery Connection API

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

ConnectionServiceClient

Service Description: Manages external data source connections and credentials.

Sample for ConnectionServiceClient:


 // 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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ConnectionProto.Connection connection = ConnectionProto.Connection.newBuilder().build();
   String connectionId = "connectionId1923106969";
   ConnectionProto.Connection response =
       connectionServiceClient.createConnection(parent, connection, connectionId);
 }

Classes

ConnectionName.Builder

Builder for projects/{project}/locations/{location}/connections/{connection}.

ConnectionProto.CloudSqlCredential

Credential info for the Cloud SQL.

Protobuf type google.cloud.bigquery.connection.v1beta1.CloudSqlCredential

ConnectionProto.CloudSqlCredential.Builder

Credential info for the Cloud SQL.

Protobuf type google.cloud.bigquery.connection.v1beta1.CloudSqlCredential

ConnectionProto.CloudSqlProperties

Connection properties specific to the Cloud SQL.

Protobuf type google.cloud.bigquery.connection.v1beta1.CloudSqlProperties

ConnectionProto.CloudSqlProperties.Builder

Connection properties specific to the Cloud SQL.

Protobuf type google.cloud.bigquery.connection.v1beta1.CloudSqlProperties

ConnectionProto.Connection

Configuration parameters to establish connection with an external data source, except the credential attributes.

Protobuf type google.cloud.bigquery.connection.v1beta1.Connection

ConnectionProto.Connection.Builder

Configuration parameters to establish connection with an external data source, except the credential attributes.

Protobuf type google.cloud.bigquery.connection.v1beta1.Connection

ConnectionProto.ConnectionCredential

Credential to use with a connection.

Protobuf type google.cloud.bigquery.connection.v1beta1.ConnectionCredential

ConnectionProto.ConnectionCredential.Builder

Credential to use with a connection.

Protobuf type google.cloud.bigquery.connection.v1beta1.ConnectionCredential

ConnectionProto.CreateConnectionRequest

The request for ConnectionService.CreateConnection.

Protobuf type google.cloud.bigquery.connection.v1beta1.CreateConnectionRequest

ConnectionProto.CreateConnectionRequest.Builder

The request for ConnectionService.CreateConnection.

Protobuf type google.cloud.bigquery.connection.v1beta1.CreateConnectionRequest

ConnectionProto.DeleteConnectionRequest

The request for [ConnectionService.DeleteConnectionRequest][].

Protobuf type google.cloud.bigquery.connection.v1beta1.DeleteConnectionRequest

ConnectionProto.DeleteConnectionRequest.Builder

The request for [ConnectionService.DeleteConnectionRequest][].

Protobuf type google.cloud.bigquery.connection.v1beta1.DeleteConnectionRequest

ConnectionProto.GetConnectionRequest

The request for ConnectionService.GetConnection.

Protobuf type google.cloud.bigquery.connection.v1beta1.GetConnectionRequest

ConnectionProto.GetConnectionRequest.Builder

The request for ConnectionService.GetConnection.

Protobuf type google.cloud.bigquery.connection.v1beta1.GetConnectionRequest

ConnectionProto.ListConnectionsRequest

The request for ConnectionService.ListConnections.

Protobuf type google.cloud.bigquery.connection.v1beta1.ListConnectionsRequest

ConnectionProto.ListConnectionsRequest.Builder

The request for ConnectionService.ListConnections.

Protobuf type google.cloud.bigquery.connection.v1beta1.ListConnectionsRequest

ConnectionProto.ListConnectionsResponse

The response for ConnectionService.ListConnections.

Protobuf type google.cloud.bigquery.connection.v1beta1.ListConnectionsResponse

ConnectionProto.ListConnectionsResponse.Builder

The response for ConnectionService.ListConnections.

Protobuf type google.cloud.bigquery.connection.v1beta1.ListConnectionsResponse

ConnectionProto.UpdateConnectionCredentialRequest

The request for ConnectionService.UpdateConnectionCredential.

Protobuf type google.cloud.bigquery.connection.v1beta1.UpdateConnectionCredentialRequest

ConnectionProto.UpdateConnectionCredentialRequest.Builder

The request for ConnectionService.UpdateConnectionCredential.

Protobuf type google.cloud.bigquery.connection.v1beta1.UpdateConnectionCredentialRequest

ConnectionProto.UpdateConnectionRequest

The request for ConnectionService.UpdateConnection.

Protobuf type google.cloud.bigquery.connection.v1beta1.UpdateConnectionRequest

ConnectionProto.UpdateConnectionRequest.Builder

The request for ConnectionService.UpdateConnection.

Protobuf type google.cloud.bigquery.connection.v1beta1.UpdateConnectionRequest

ConnectionServiceClient

Service Description: Manages external data source connections and credentials.

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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ConnectionProto.Connection connection = ConnectionProto.Connection.newBuilder().build();
   String connectionId = "connectionId1923106969";
   ConnectionProto.Connection response =
       connectionServiceClient.createConnection(parent, connection, connectionId);
 }

Note: close() needs to be called on the ConnectionServiceClient 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 ConnectionServiceSettings 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
 ConnectionServiceSettings connectionServiceSettings =
     ConnectionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConnectionServiceClient connectionServiceClient =
     ConnectionServiceClient.create(connectionServiceSettings);

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
 ConnectionServiceSettings connectionServiceSettings =
     ConnectionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConnectionServiceClient connectionServiceClient =
     ConnectionServiceClient.create(connectionServiceSettings);

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
 ConnectionServiceSettings connectionServiceSettings =
     ConnectionServiceSettings.newHttpJsonBuilder().build();
 ConnectionServiceClient connectionServiceClient =
     ConnectionServiceClient.create(connectionServiceSettings);

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

The default service address (bigqueryconnection.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 createConnection 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
 ConnectionServiceSettings.Builder connectionServiceSettingsBuilder =
     ConnectionServiceSettings.newBuilder();
 connectionServiceSettingsBuilder
     .createConnectionSettings()
     .setRetrySettings(
         connectionServiceSettingsBuilder
             .createConnectionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConnectionServiceSettings connectionServiceSettings = connectionServiceSettingsBuilder.build();

Package com.google.cloud.bigquery.connection.v1beta1 (2.29.0)

ConnectionServiceClient

Classes

Interfaces

Enums