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

GitHub Repository

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.bigquery.datatransfer.v1.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:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceSettings Settings class to configure an instance of DataTransferServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.bigquery.datatransfer.v1.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.
com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest.Builder 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.
com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse A response indicating whether the credentials exist and are valid.
com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse.Builder A response indicating whether the credentials exist and are valid.
com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, authorization info must be provided. If authorization info is provided, the transfer configuration will be
com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest.Builder A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, authorization info must be provided. If authorization info is provided, the transfer configuration will be
com.google.cloud.bigquery.datatransfer.v1.DataSource Defines the properties and custom parameters for a data source.
com.google.cloud.bigquery.datatransfer.v1.DataSource.Builder Defines the properties and custom parameters for a data source.
com.google.cloud.bigquery.datatransfer.v1.DataSourceName
com.google.cloud.bigquery.datatransfer.v1.DataSourceName.Builder Builder for projects/{project}/dataSources/{data_source}.
com.google.cloud.bigquery.datatransfer.v1.DataSourceName.ProjectLocationDataSourceBuilder Builder for projects/{project}/locations/{location}/dataSources/{data_source}.
com.google.cloud.bigquery.datatransfer.v1.DataSourceParameter A parameter used to define custom fields in a data source definition.
com.google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Builder A parameter used to define custom fields in a data source definition.
com.google.cloud.bigquery.datatransfer.v1.DataTransferProto
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListDataSourcesFixedSizeCollection
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListDataSourcesPage
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListDataSourcesPagedResponse
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListLocationsFixedSizeCollection
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListLocationsPage
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListLocationsPagedResponse
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferConfigsFixedSizeCollection
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferConfigsPage
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferConfigsPagedResponse
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferLogsFixedSizeCollection
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferLogsPage
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferLogsPagedResponse
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferRunsFixedSizeCollection
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferRunsPage
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient.ListTransferRunsPagedResponse
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceGrpc This API allows users to manage their data transfers into BigQuery.
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceGrpc.DataTransferServiceImplBase Base class for the server implementation of the service DataTransferService. This API allows users to manage their data transfers into BigQuery.
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceSettings.Builder Builder for DataTransferServiceSettings.
com.google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
com.google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest.Builder A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
com.google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest A request to delete data transfer run information.
com.google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest.Builder A request to delete data transfer run information.
com.google.cloud.bigquery.datatransfer.v1.EmailPreferences Represents preferences for sending email notifications for transfer run events.
com.google.cloud.bigquery.datatransfer.v1.EmailPreferences.Builder Represents preferences for sending email notifications for transfer run events.
com.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration Represents the encryption configuration for a transfer.
com.google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration.Builder Represents the encryption configuration for a transfer.
com.google.cloud.bigquery.datatransfer.v1.EnrollDataSourcesRequest A request to enroll a set of data sources so they are visible in the BigQuery UI's Transfer tab.
com.google.cloud.bigquery.datatransfer.v1.EnrollDataSourcesRequest.Builder A request to enroll a set of data sources so they are visible in the BigQuery UI's Transfer tab.
com.google.cloud.bigquery.datatransfer.v1.EventDrivenSchedule Options customizing EventDriven transfers schedule.
com.google.cloud.bigquery.datatransfer.v1.EventDrivenSchedule.Builder Options customizing EventDriven transfers schedule.
com.google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest A request to get data source info.
com.google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest.Builder A request to get data source info.
com.google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest A request to get data transfer information.
com.google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest.Builder A request to get data transfer information.
com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest A request to get data transfer run information.
com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest.Builder A request to get data transfer run information.
com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest Request to list supported data sources and their data transfer settings.
com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest.Builder Request to list supported data sources and their data transfer settings.
com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse Returns list of supported data sources and their metadata.
com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse.Builder Returns list of supported data sources and their metadata.
com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest A request to list data transfers configured for a BigQuery project.
com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest.Builder A request to list data transfers configured for a BigQuery project.
com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse The returned list of pipelines in the project.
com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse.Builder The returned list of pipelines in the project.
com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest A request to get user facing log messages associated with data transfer run.
com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest.Builder A request to get user facing log messages associated with data transfer run.
com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse The returned list transfer run messages.
com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse.Builder The returned list transfer run messages.
com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest A request to list data transfer runs.
com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.Builder A request to list data transfer runs.
com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse The returned list of pipelines in the project.
com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse.Builder The returned list of pipelines in the project.
com.google.cloud.bigquery.datatransfer.v1.LocationName
com.google.cloud.bigquery.datatransfer.v1.LocationName.Builder Builder for projects/{project}/locations/{location}.
com.google.cloud.bigquery.datatransfer.v1.ManualSchedule Options customizing manual transfers schedule.
com.google.cloud.bigquery.datatransfer.v1.ManualSchedule.Builder Options customizing manual transfers schedule.
com.google.cloud.bigquery.datatransfer.v1.ProjectName
com.google.cloud.bigquery.datatransfer.v1.ProjectName.Builder Builder for projects/{project}.
com.google.cloud.bigquery.datatransfer.v1.RunName
com.google.cloud.bigquery.datatransfer.v1.RunName.Builder Builder for projects/{project}/transferConfigs/{transfer_config}/runs/{run}.
com.google.cloud.bigquery.datatransfer.v1.RunName.ProjectLocationTransferConfigRunBuilder Builder for projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}.
com.google.cloud.bigquery.datatransfer.v1.SampleApp
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptions Options customizing the data transfer schedule.
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptions.Builder Options customizing the data transfer schedule.
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2 V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2.Builder V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used
com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest A request to schedule transfer runs for a time range.
com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest.Builder A request to schedule transfer runs for a time range.
com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse A response to schedule transfer runs for a time range.
com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse.Builder A response to schedule transfer runs for a time range.
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest A request to start manual transfer runs.
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.Builder A request to start manual transfer runs.
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
com.google.cloud.bigquery.datatransfer.v1.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).
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse A response to start manual transfer runs.
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse.Builder A response to start manual transfer runs.
com.google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
com.google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule.Builder Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
com.google.cloud.bigquery.datatransfer.v1.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.
com.google.cloud.bigquery.datatransfer.v1.TransferConfig.Builder 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.
com.google.cloud.bigquery.datatransfer.v1.TransferConfigName
com.google.cloud.bigquery.datatransfer.v1.TransferConfigName.Builder Builder for projects/{project}/transferConfigs/{transfer_config}.
com.google.cloud.bigquery.datatransfer.v1.TransferConfigName.ProjectLocationTransferConfigBuilder Builder for projects/{project}/locations/{location}/transferConfigs/{transfer_config}.
com.google.cloud.bigquery.datatransfer.v1.TransferMessage Represents a user facing message for a particular data transfer run.
com.google.cloud.bigquery.datatransfer.v1.TransferMessage.Builder Represents a user facing message for a particular data transfer run.
com.google.cloud.bigquery.datatransfer.v1.TransferProto
com.google.cloud.bigquery.datatransfer.v1.TransferRun Represents a data transfer run.
com.google.cloud.bigquery.datatransfer.v1.TransferRun.Builder Represents a data transfer run.
com.google.cloud.bigquery.datatransfer.v1.UnenrollDataSourcesRequest A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's Transfer tab.
com.google.cloud.bigquery.datatransfer.v1.UnenrollDataSourcesRequest.Builder A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's Transfer tab.
com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.
com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.Builder A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.
com.google.cloud.bigquery.datatransfer.v1.UserInfo Information about a user.
com.google.cloud.bigquery.datatransfer.v1.UserInfo.Builder Information about a user.

Interfaces

Interface Description
com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponseOrBuilder
com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.DataSourceOrBuilder
com.google.cloud.bigquery.datatransfer.v1.DataSourceParameterOrBuilder
com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceGrpc.AsyncService This API allows users to manage their data transfers into BigQuery.
com.google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.EmailPreferencesOrBuilder
com.google.cloud.bigquery.datatransfer.v1.EncryptionConfigurationOrBuilder
com.google.cloud.bigquery.datatransfer.v1.EnrollDataSourcesRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.EventDrivenScheduleOrBuilder
com.google.cloud.bigquery.datatransfer.v1.GetDataSourceRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponseOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponseOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponseOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponseOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ManualScheduleOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2OrBuilder
com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponseOrBuilder
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRangeOrBuilder
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponseOrBuilder
com.google.cloud.bigquery.datatransfer.v1.TimeBasedScheduleOrBuilder
com.google.cloud.bigquery.datatransfer.v1.TransferConfigOrBuilder
com.google.cloud.bigquery.datatransfer.v1.TransferMessageOrBuilder
com.google.cloud.bigquery.datatransfer.v1.TransferRunOrBuilder
com.google.cloud.bigquery.datatransfer.v1.UnenrollDataSourcesRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequestOrBuilder
com.google.cloud.bigquery.datatransfer.v1.UserInfoOrBuilder

Enums

Enum Description
com.google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType The type of authorization needed for this data source.
com.google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType Represents how the data source supports data auto refresh.
com.google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type Parameter type.
com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt Represents which runs should be pulled.
com.google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2.ScheduleCase
com.google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeCase
com.google.cloud.bigquery.datatransfer.v1.TransferConfig.DestinationCase
com.google.cloud.bigquery.datatransfer.v1.TransferMessage.MessageSeverity Represents data transfer user facing message severity.
com.google.cloud.bigquery.datatransfer.v1.TransferRun.DestinationCase
com.google.cloud.bigquery.datatransfer.v1.TransferState Represents data transfer run state.
com.google.cloud.bigquery.datatransfer.v1.TransferType DEPRECATED. Represents data transfer type.