Package com.google.cloud.bigquery.datatransfer.v1 (2.2.6)

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

DataTransferServiceClient

Service Description: This API allows users to manage their data transfers into BigQuery.

Sample for DataTransferServiceClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name =
       DataSourceName.ofProjectLocationDataSourceName(
           "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]");
   DataSource response = dataTransferServiceClient.getDataSource(name);
 }

Classes

CheckValidCredsRequest

A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.

Protobuf type google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest

CheckValidCredsRequest.Builder

Protobuf type google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest

CheckValidCredsResponse

A response indicating whether the credentials exist and are valid.

Protobuf type google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse

CheckValidCredsResponse.Builder

A response indicating whether the credentials exist and are valid.

Protobuf type google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse

CreateDataSourceDefinitionRequest

Represents the request of the CreateDataSourceDefinition method.

Protobuf type google.cloud.bigquery.datatransfer.v1.CreateDataSourceDefinitionRequest

CreateDataSourceDefinitionRequest.Builder

Represents the request of the CreateDataSourceDefinition method.

Protobuf type google.cloud.bigquery.datatransfer.v1.CreateDataSourceDefinitionRequest

CreateTransferConfigRequest

A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, an authorization code must be provided. If an authorization code is provided, the transfer configuration will be associated with the user id corresponding to the authorization code. Otherwise, the transfer configuration will be associated with the calling user.

Protobuf type google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest

CreateTransferConfigRequest.Builder

Protobuf type google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest

DataSource

Defines the properties and custom parameters for a data source.

Protobuf type google.cloud.bigquery.datatransfer.v1.DataSource

DataSource.Builder

Defines the properties and custom parameters for a data source.

Protobuf type google.cloud.bigquery.datatransfer.v1.DataSource

DataSourceDefinition

Represents the data source definition.

Protobuf type google.cloud.bigquery.datatransfer.v1.DataSourceDefinition

DataSourceDefinition.Builder

Represents the data source definition.

Protobuf type google.cloud.bigquery.datatransfer.v1.DataSourceDefinition

DataSourceName

DataSourceName.Builder

Builder for projects/{project}/dataSources/{data_source}.

DataSourceName.ProjectLocationDataSourceBuilder

Builder for projects/{project}/locations/{location}/dataSources/{data_source}.

DataSourceNames (deprecated)

Deprecated. This resource name class will be removed in the next major version.

AUTO-GENERATED DOCUMENTATION AND CLASS

DataSourceParameter

A parameter used to define custom fields in a data source definition.

Protobuf type google.cloud.bigquery.datatransfer.v1.DataSourceParameter

DataSourceParameter.Builder

A parameter used to define custom fields in a data source definition.

Protobuf type google.cloud.bigquery.datatransfer.v1.DataSourceParameter

DataSourceProto

DataSourceServiceGrpc

The Google BigQuery Data Transfer API allows BigQuery users to configure transfer of their data from other Google Products into BigQuery. This service exposes methods that should be used by data source backend.

DataSourceServiceGrpc.DataSourceServiceBlockingStub

DataSourceServiceGrpc.DataSourceServiceFutureStub

DataSourceServiceGrpc.DataSourceServiceImplBase

DataSourceServiceGrpc.DataSourceServiceStub

DataTransferProto

DataTransferServiceClient

Service Description: This API allows users to manage their data transfers into BigQuery.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name =
       DataSourceName.ofProjectLocationDataSourceName(
           "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]");
   DataSource response = dataTransferServiceClient.getDataSource(name);
 }

Note: close() needs to be called on the DataTransferServiceClient 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 DataTransferServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DataTransferServiceSettings dataTransferServiceSettings =
     DataTransferServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataTransferServiceClient dataTransferServiceClient =
     DataTransferServiceClient.create(dataTransferServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DataTransferServiceSettings dataTransferServiceSettings =
     DataTransferServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataTransferServiceClient dataTransferServiceClient =
     DataTransferServiceClient.create(dataTransferServiceSettings);

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

DataTransferServiceClient.ListDataSourcesFixedSizeCollection

DataTransferServiceClient.ListDataSourcesPage

DataTransferServiceClient.ListDataSourcesPagedResponse

DataTransferServiceClient.ListTransferConfigsFixedSizeCollection

DataTransferServiceClient.ListTransferConfigsPage

DataTransferServiceClient.ListTransferConfigsPagedResponse

DataTransferServiceClient.ListTransferLogsFixedSizeCollection

DataTransferServiceClient.ListTransferLogsPage

DataTransferServiceClient.ListTransferLogsPagedResponse

DataTransferServiceClient.ListTransferRunsFixedSizeCollection

DataTransferServiceClient.ListTransferRunsPage

DataTransferServiceClient.ListTransferRunsPagedResponse

DataTransferServiceGrpc

This API allows users to manage their data transfers into BigQuery.

DataTransferServiceGrpc.DataTransferServiceBlockingStub

This API allows users to manage their data transfers into BigQuery.

DataTransferServiceGrpc.DataTransferServiceFutureStub

This API allows users to manage their data transfers into BigQuery.

DataTransferServiceGrpc.DataTransferServiceImplBase

This API allows users to manage their data transfers into BigQuery.

DataTransferServiceGrpc.DataTransferServiceStub

This API allows users to manage their data transfers into BigQuery.

DataTransferServiceSettings

Settings class to configure an instance of DataTransferServiceClient.

The default instance has everything set to sensible defaults:

The default service address (bigquerydatatransfer.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 getDataSource to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DataTransferServiceSettings.Builder dataTransferServiceSettingsBuilder =
     DataTransferServiceSettings.newBuilder();
 dataTransferServiceSettingsBuilder
     .getDataSourceSettings()
     .setRetrySettings(
         dataTransferServiceSettingsBuilder
             .getDataSourceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataTransferServiceSettings dataTransferServiceSettings =
     dataTransferServiceSettingsBuilder.build();

DataTransferServiceSettings.Builder

Builder for DataTransferServiceSettings.

DeleteDataSourceDefinitionRequest

Represents the request of the DeleteDataSourceDefinition method. All transfer configs associated with the data source must be deleted first, before the data source can be deleted.

Protobuf type google.cloud.bigquery.datatransfer.v1.DeleteDataSourceDefinitionRequest

DeleteDataSourceDefinitionRequest.Builder

Represents the request of the DeleteDataSourceDefinition method. All transfer configs associated with the data source must be deleted first, before the data source can be deleted.

Protobuf type google.cloud.bigquery.datatransfer.v1.DeleteDataSourceDefinitionRequest

DeleteTransferConfigRequest

A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.

Protobuf type google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest

DeleteTransferConfigRequest.Builder

A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.

Protobuf type google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest

DeleteTransferRunRequest

A request to delete data transfer run information.

Protobuf type google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest

DeleteTransferRunRequest.Builder

A request to delete data transfer run information.

Protobuf type google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest

EmailPreferences

Represents preferences for sending email notifications for transfer run events.

Protobuf type google.cloud.bigquery.datatransfer.v1.EmailPreferences

EmailPreferences.Builder

Represents preferences for sending email notifications for transfer run events.

Protobuf type google.cloud.bigquery.datatransfer.v1.EmailPreferences

EnrollDataSourcesRequest

A request to enroll a set of data sources so they are visible in the BigQuery UI's Transfer tab.

Protobuf type google.cloud.bigquery.datatransfer.v1.EnrollDataSourcesRequest

EnrollDataSourcesRequest.Builder

A request to enroll a set of data sources so they are visible in the BigQuery UI's Transfer tab.

Protobuf type google.cloud.bigquery.datatransfer.v1.EnrollDataSourcesRequest

FinishRunRequest

A request to finish a run.

Protobuf type google.cloud.bigquery.datatransfer.v1.FinishRunRequest

FinishRunRequest.Builder

A request to finish a run.

Protobuf type google.cloud.bigquery.datatransfer.v1.FinishRunRequest

GetDataSourceDefinitionRequest

Represents the request of the GetDataSourceDefinition method.

Protobuf type google.cloud.bigquery.datatransfer.v1.GetDataSourceDefinitionRequest

GetDataSourceDefinitionRequest.Builder

Represents the request of the GetDataSourceDefinition method.

Protobuf type google.cloud.bigquery.datatransfer.v1.GetDataSourceDefinitionRequest

GetDataSourceRequest

A request to get data source info.

Protobuf type google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest

GetDataSourceRequest.Builder

A request to get data source info.

Protobuf type google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest

GetTransferConfigRequest

A request to get data transfer information.

Protobuf type google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest

GetTransferConfigRequest.Builder

A request to get data transfer information.

Protobuf type google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest

GetTransferRunRequest

A request to get data transfer run information.

Protobuf type google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest

GetTransferRunRequest.Builder

A request to get data transfer run information.

Protobuf type google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest

ImportedDataInfo

Describes data which should be imported.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo

ImportedDataInfo.Builder

Describes data which should be imported.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo

ImportedDataInfo.FieldSchema

Defines schema of a field in the imported data.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.FieldSchema

ImportedDataInfo.FieldSchema.Builder

Defines schema of a field in the imported data.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.FieldSchema

ImportedDataInfo.RecordSchema

Describes schema of the data to be ingested.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.RecordSchema

ImportedDataInfo.RecordSchema.Builder

Describes schema of the data to be ingested.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.RecordSchema

ImportedDataInfo.TableDefinition

External table definition. These tables can be referenced with 'name' in the query and can be read just like any other table.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.TableDefinition

ImportedDataInfo.TableDefinition.Builder

External table definition. These tables can be referenced with 'name' in the query and can be read just like any other table.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.TableDefinition

ImportedDataInfo.TableDefinition.CsvOptions

CSV specific options.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.TableDefinition.CsvOptions

ImportedDataInfo.TableDefinition.CsvOptions.Builder

CSV specific options.

Protobuf type google.cloud.bigquery.datatransfer.v1.ImportedDataInfo.TableDefinition.CsvOptions

ListDataSourceDefinitionsRequest

Represents the request of the ListDataSourceDefinitions method.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListDataSourceDefinitionsRequest

ListDataSourceDefinitionsRequest.Builder

Represents the request of the ListDataSourceDefinitions method.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListDataSourceDefinitionsRequest

ListDataSourceDefinitionsResponse

Returns a list of supported data source definitions.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListDataSourceDefinitionsResponse

ListDataSourceDefinitionsResponse.Builder

Returns a list of supported data source definitions.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListDataSourceDefinitionsResponse

ListDataSourcesRequest

Request to list supported data sources and their data transfer settings.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest

ListDataSourcesRequest.Builder

Request to list supported data sources and their data transfer settings.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest

ListDataSourcesResponse

Returns list of supported data sources and their metadata.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse

ListDataSourcesResponse.Builder

Returns list of supported data sources and their metadata.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse

ListTransferConfigsRequest

A request to list data transfers configured for a BigQuery project.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest

ListTransferConfigsRequest.Builder

A request to list data transfers configured for a BigQuery project.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest

ListTransferConfigsResponse

The returned list of pipelines in the project.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse

ListTransferConfigsResponse.Builder

The returned list of pipelines in the project.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse

ListTransferLogsRequest

A request to get user facing log messages associated with data transfer run.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest

ListTransferLogsRequest.Builder

A request to get user facing log messages associated with data transfer run.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest

ListTransferLogsResponse

The returned list transfer run messages.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse

ListTransferLogsResponse.Builder

The returned list transfer run messages.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse

ListTransferRunsRequest

A request to list data transfer runs.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest

ListTransferRunsRequest.Builder

A request to list data transfer runs.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest

ListTransferRunsResponse

The returned list of pipelines in the project.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse

ListTransferRunsResponse.Builder

The returned list of pipelines in the project.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse

LocationDataSourceName (deprecated)

Deprecated. This resource name class will be removed in the next major version.

AUTO-GENERATED DOCUMENTATION AND CLASS

LocationDataSourceName.Builder

Builder for LocationDataSourceName.

LocationName

LocationName.Builder

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

LocationRunName (deprecated)

Deprecated. This resource name class will be removed in the next major version.

AUTO-GENERATED DOCUMENTATION AND CLASS

LocationRunName.Builder

Builder for LocationRunName.

LocationTransferConfigName (deprecated)

Deprecated. This resource name class will be removed in the next major version.

AUTO-GENERATED DOCUMENTATION AND CLASS

LocationTransferConfigName.Builder

Builder for LocationTransferConfigName.

LogTransferRunMessagesRequest

A request to add transfer status messages to the run.

Protobuf type google.cloud.bigquery.datatransfer.v1.LogTransferRunMessagesRequest

LogTransferRunMessagesRequest.Builder

A request to add transfer status messages to the run.

Protobuf type google.cloud.bigquery.datatransfer.v1.LogTransferRunMessagesRequest

ProjectDataSourceName (deprecated)

Deprecated. This resource name class will be removed in the next major version.

AUTO-GENERATED DOCUMENTATION AND CLASS

ProjectDataSourceName.Builder

Builder for ProjectDataSourceName.

ProjectName

ProjectName.Builder

Builder for projects/{project}.

ProjectRunName (deprecated)

Deprecated. This resource name class will be removed in the next major version.

AUTO-GENERATED DOCUMENTATION AND CLASS

ProjectRunName.Builder

Builder for ProjectRunName.

ProjectTransferConfigName (deprecated)

Deprecated. This resource name class will be removed in the next major version.

AUTO-GENERATED DOCUMENTATION AND CLASS

ProjectTransferConfigName.Builder

Builder for ProjectTransferConfigName.

RunName

RunName.Builder

Builder for projects/{project}/transferConfigs/{transfer_config}/runs/{run}.

RunName.ProjectLocationTransferConfigRunBuilder

Builder for projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}.

RunNames (deprecated)

Deprecated. This resource name class will be removed in the next major version.

AUTO-GENERATED DOCUMENTATION AND CLASS

SampleApp

ScheduleOptions

Options customizing the data transfer schedule.

Protobuf type google.cloud.bigquery.datatransfer.v1.ScheduleOptions

ScheduleOptions.Builder

Options customizing the data transfer schedule.

Protobuf type google.cloud.bigquery.datatransfer.v1.ScheduleOptions

ScheduleTransferRunsRequest

A request to schedule transfer runs for a time range.

Protobuf type google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest

ScheduleTransferRunsRequest.Builder

A request to schedule transfer runs for a time range.

Protobuf type google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest

ScheduleTransferRunsResponse

A response to schedule transfer runs for a time range.

Protobuf type google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse

ScheduleTransferRunsResponse.Builder

A response to schedule transfer runs for a time range.

Protobuf type google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse

StartBigQueryJobsRequest

A request to start and monitor a BigQuery load job.

Protobuf type google.cloud.bigquery.datatransfer.v1.StartBigQueryJobsRequest

StartBigQueryJobsRequest.Builder

A request to start and monitor a BigQuery load job.

Protobuf type google.cloud.bigquery.datatransfer.v1.StartBigQueryJobsRequest

StartManualTransferRunsRequest

A request to start manual transfer runs.

Protobuf type google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest

StartManualTransferRunsRequest.Builder

A request to start manual transfer runs.

Protobuf type google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest

StartManualTransferRunsRequest.TimeRange

A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).

Protobuf type google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange

StartManualTransferRunsRequest.TimeRange.Builder

A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).

Protobuf type google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange

StartManualTransferRunsResponse

A response to start manual transfer runs.

Protobuf type google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse

StartManualTransferRunsResponse.Builder

A response to start manual transfer runs.

Protobuf type google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse

TransferConfig

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destination_dataset_id specifies where data should be stored. When a new transfer configuration is created, the specified destination_dataset_id is created when needed and shared with the appropriate data source service account.

Protobuf type google.cloud.bigquery.datatransfer.v1.TransferConfig