http4s-grpc-google-cloud-bigquerydatatransfer-v1
2.30.0+0.0.6
API
Generated with
http4s-grpc-google-cloud-bigquerydatatransfer-v1/com.google.cloud.bigquery.datatransfer.v1/com.google.cloud.bigquery.datatransfer.v1.datasource

com.google.cloud.bigquery.datatransfer.v1.datasource

package com.google.cloud.bigquery.datatransfer.v1.datasource

Members list

Type members

Classlikes

final case class CreateDataSourceDefinitionRequest(parent: String, dataSourceDefinition: Option[DataSourceDefinition], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CreateDataSourceDefinitionRequest]

Represents the request of the CreateDataSourceDefinition method.

Represents the request of the CreateDataSourceDefinition method.

Value parameters

dataSourceDefinition

Data source definition.

parent

The BigQuery project id for which data source definition is associated. Must be in the form: projects/{project_id}/locations/{location_id}

Attributes

Companion
object
Source
CreateDataSourceDefinitionRequest.scala
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CreateDataSourceDefinitionRequest extends GeneratedMessageCompanion[CreateDataSourceDefinitionRequest]

Attributes

Companion
class
Source
CreateDataSourceDefinitionRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateDataSourceDefinitionRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DataSourceDefinition(name: String, dataSource: Option[DataSource], transferRunPubsubTopic: String, runTimeOffset: Option[Duration], supportEmail: String, serviceAccount: String, disabled: Boolean, transferConfigPubsubTopic: String, supportedLocationIds: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DataSourceDefinition]

Represents the data source definition.

Represents the data source definition.

Value parameters

dataSource

Data source metadata.

disabled

Is data source disabled? If true, data_source is not visible. API will also stop returning any data transfer configs and/or runs associated with the data source. This setting has higher priority than whitelisted_project_ids.

name

The resource name of the data source definition. Data source definition names have the form projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}.

runTimeOffset

Duration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.

serviceAccount

When service account is specified, BigQuery will share created dataset with the given service account. Also, this service account will be eligible to perform status updates and message logging for data transfer runs for the corresponding data_source_id.

supportEmail

Support e-mail address of the OAuth client's Brand, which contains the consent screen data.

supportedLocationIds

Supported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;

transferConfigPubsubTopic

The Pub/Sub topic to use for broadcasting a message for transfer config. If empty, a message will not be broadcasted. Both this topic and transfer_run_pubsub_topic are auto-generated if none of them is provided when creating the definition. It is recommended to provide transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is provided. Otherwise, it will be set to empty. If "{location}" is found in the value, then that means, data source wants to handle message separately for datasets in different regions. We will replace {location} with the actual dataset location, as the actual topic name. For example, projects/connector/topics/scheduler-{location} could become projects/connector/topics/scheduler-us. If "{location}" is not found, then we will use the input value as topic name.

transferRunPubsubTopic

The Pub/Sub topic to be used for broadcasting a message when a transfer run is created. Both this topic and transfer_config_pubsub_topic can be set to a custom topic. By default, both topics are auto-generated if none of them is provided when creating the definition. However, if one topic is manually set, the other topic has to be manually set as well. The only difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub topic, but transfer_config_pubsub_topic can be set to empty. The comments about "{location}" for transfer_config_pubsub_topic apply here too.

Attributes

Companion
object
Source
DataSourceDefinition.scala
Supertypes
trait Updatable[DataSourceDefinition]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DataSourceDefinition extends GeneratedMessageCompanion[DataSourceDefinition]

Attributes

Companion
class
Source
DataSourceDefinition.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DataSourceDefinition]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
trait DataSourceService[F[_]]

The Google BigQuery Data Transfer API allows BigQuery users to configure transfer of their data from other Google Products into BigQuery.

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.

Attributes

Companion
object
Source
DataSourceService.scala
Supertypes
class Object
trait Matchable
class Any
object DataSourceService

Attributes

Companion
trait
Source
DataSourceService.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object DatasourceProto extends GeneratedFileObject

Attributes

Source
DatasourceProto.scala
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class DeleteDataSourceDefinitionRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DeleteDataSourceDefinitionRequest]

Represents the request of the DeleteDataSourceDefinition method.

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.

Value parameters

name

The field will contain name of the resource requested, for example: projects/{project_id}/locations/{location_id}/dataSourceDefinitions/{data_source_id}

Attributes

Companion
object
Source
DeleteDataSourceDefinitionRequest.scala
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeleteDataSourceDefinitionRequest extends GeneratedMessageCompanion[DeleteDataSourceDefinitionRequest]

Attributes

Companion
class
Source
DeleteDataSourceDefinitionRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteDataSourceDefinitionRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class FinishRunRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FinishRunRequest]

A request to finish a run.

A request to finish a run.

Value parameters

name

Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"

Attributes

Companion
object
Source
FinishRunRequest.scala
Supertypes
trait Updatable[FinishRunRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FinishRunRequest extends GeneratedMessageCompanion[FinishRunRequest]

Attributes

Companion
class
Source
FinishRunRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[FinishRunRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetDataSourceDefinitionRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetDataSourceDefinitionRequest]

Represents the request of the GetDataSourceDefinition method.

Represents the request of the GetDataSourceDefinition method.

Value parameters

name

The field will contain name of the resource requested.

Attributes

Companion
object
Source
GetDataSourceDefinitionRequest.scala
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetDataSourceDefinitionRequest extends GeneratedMessageCompanion[GetDataSourceDefinitionRequest]

Attributes

Companion
class
Source
GetDataSourceDefinitionRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetDataSourceDefinitionRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ImportedDataInfo(sql: String, destinationTableId: String, destinationTableDescription: String, tableDefs: Seq[TableDefinition], userDefinedFunctions: Seq[String], writeDisposition: WriteDisposition, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ImportedDataInfo]

Describes data which should be imported.

Describes data which should be imported.

Value parameters

destinationTableDescription

The description of a destination table. This can be several sentences or paragraphs describing the table contents in detail.

destinationTableId

Table where results should be written.

sql

SQL query to run. When empty, API checks that there is only one table_def specified and loads this table. Only Standard SQL queries are accepted. Legacy SQL is not allowed.

tableDefs

When used WITHOUT the "sql" parameter, describes the schema of the destination table. When used WITH the "sql" parameter, describes tables with data stored outside of BigQuery.

userDefinedFunctions

Inline code for User-defined function resources. Ignored when "sql" parameter is empty.

writeDisposition

Specifies the action if the destination table already exists.

Attributes

Companion
object
Source
ImportedDataInfo.scala
Supertypes
trait Updatable[ImportedDataInfo]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ImportedDataInfo extends GeneratedMessageCompanion[ImportedDataInfo]

Attributes

Companion
class
Source
ImportedDataInfo.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ImportedDataInfo]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ListDataSourceDefinitionsRequest(parent: String, pageToken: String, pageSize: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListDataSourceDefinitionsRequest]

Represents the request of the ListDataSourceDefinitions method.

Represents the request of the ListDataSourceDefinitions method.

Value parameters

pageSize

Page size. The default page size is the maximum value of 1000 results.

pageToken

Pagination token, which can be used to request a specific page of ListDataSourceDefinitionsRequest list results. For multiple-page results, ListDataSourceDefinitionsResponse outputs a next_page token, which can be used as the page_token value to request the next page of the list results.

parent

The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id}/locations/{location_id}

Attributes

Companion
object
Source
ListDataSourceDefinitionsRequest.scala
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListDataSourceDefinitionsRequest extends GeneratedMessageCompanion[ListDataSourceDefinitionsRequest]

Attributes

Companion
class
Source
ListDataSourceDefinitionsRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListDataSourceDefinitionsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ListDataSourceDefinitionsResponse(dataSourceDefinitions: Seq[DataSourceDefinition], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListDataSourceDefinitionsResponse]

Returns a list of supported data source definitions.

Returns a list of supported data source definitions.

Value parameters

dataSourceDefinitions

List of supported data source definitions.

nextPageToken

Output only. The next-pagination token. For multiple-page list results, this token can be used as the ListDataSourceDefinitionsRequest.page_token to request the next page of the list results.

Attributes

Companion
object
Source
ListDataSourceDefinitionsResponse.scala
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListDataSourceDefinitionsResponse extends GeneratedMessageCompanion[ListDataSourceDefinitionsResponse]

Attributes

Companion
class
Source
ListDataSourceDefinitionsResponse.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListDataSourceDefinitionsResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class LogTransferRunMessagesRequest(name: String, transferMessages: Seq[TransferMessage], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[LogTransferRunMessagesRequest]

A request to add transfer status messages to the run.

A request to add transfer status messages to the run.

Value parameters

name

Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"

transferMessages

Messages to append.

Attributes

Companion
object
Source
LogTransferRunMessagesRequest.scala
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LogTransferRunMessagesRequest extends GeneratedMessageCompanion[LogTransferRunMessagesRequest]

Attributes

Companion
class
Source
LogTransferRunMessagesRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[LogTransferRunMessagesRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class StartBigQueryJobsRequest(name: String, importedData: Seq[ImportedDataInfo], userCredentials: ByteString, maxParallelism: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[StartBigQueryJobsRequest]

A request to start and monitor a BigQuery load job.

A request to start and monitor a BigQuery load job.

Value parameters

importedData

Import jobs which should be started and monitored.

maxParallelism

The number of BQ Jobs that can run in parallel.

name

Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"

userCredentials

User credentials which should be used to start/monitor BigQuery jobs. If not specified, then jobs are started using data source service account credentials. This may be OAuth token or JWT token.

Attributes

Companion
object
Source
StartBigQueryJobsRequest.scala
Supertypes
trait Updatable[StartBigQueryJobsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StartBigQueryJobsRequest extends GeneratedMessageCompanion[StartBigQueryJobsRequest]

Attributes

Companion
class
Source
StartBigQueryJobsRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[StartBigQueryJobsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateDataSourceDefinitionRequest(dataSourceDefinition: Option[DataSourceDefinition], updateMask: Option[FieldMask], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UpdateDataSourceDefinitionRequest]

Represents the request of the UpdateDataSourceDefinition method.

Represents the request of the UpdateDataSourceDefinition method.

Value parameters

dataSourceDefinition

Data source definition.

updateMask

Update field mask.

Attributes

Companion
object
Source
UpdateDataSourceDefinitionRequest.scala
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateDataSourceDefinitionRequest extends GeneratedMessageCompanion[UpdateDataSourceDefinitionRequest]

Attributes

Companion
class
Source
UpdateDataSourceDefinitionRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateDataSourceDefinitionRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateTransferRunRequest(transferRun: Option[TransferRun], updateMask: Option[FieldMask], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UpdateTransferRunRequest]

A request to update a transfer run.

A request to update a transfer run.

Value parameters

transferRun

Run name must be set and correspond to an already existing run. Only state, error_status, and data_version fields will be updated. All other fields will be ignored.

updateMask

Required list of fields to be updated in this request.

Attributes

Companion
object
Source
UpdateTransferRunRequest.scala
Supertypes
trait Updatable[UpdateTransferRunRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateTransferRunRequest extends GeneratedMessageCompanion[UpdateTransferRunRequest]

Attributes

Companion
class
Source
UpdateTransferRunRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateTransferRunRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class WriteDisposition(val value: Int) extends GeneratedEnum

Options for writing to the table.

Options for writing to the table. The WRITE_EMPTY option is intentionally excluded from the enum and is not supported by the data transfer service.

Attributes

Companion
object
Source
WriteDisposition.scala
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Recognized
object WRITE_APPEND.type
object WRITE_TRUNCATE.type
class Unrecognized
object WriteDisposition extends GeneratedEnumCompanion[WriteDisposition]

Attributes

Companion
class
Source
WriteDisposition.scala
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[WriteDisposition]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Generated with