http4s-grpc-google-cloud-bigquerydatatransfer-v1
2.13.0+0.0.2
API
Generated with
http4s-grpc-google-cloud-bigquerydatatransfer-v1/com.google.cloud.bigquery.datatransfer.v1.datatransfer

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

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

Members list

Concise view

Type members

Classlikes

final case class CheckValidCredsRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[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.

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.

Attributes

name

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

Companion:
object
Source:
CheckValidCredsRequest.scala
Graph
Supertypes
trait Updatable[CheckValidCredsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CheckValidCredsRequest extends GeneratedMessageCompanion[CheckValidCredsRequest]

Attributes

Companion:
class
Source:
CheckValidCredsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CheckValidCredsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class CheckValidCredsResponse(hasValidCreds: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[CheckValidCredsResponse]

A response indicating whether the credentials exist and are valid.

A response indicating whether the credentials exist and are valid.

Attributes

hasValidCreds

If set to true, the credentials exist and are valid.

Companion:
object
Source:
CheckValidCredsResponse.scala
Graph
Supertypes
trait Updatable[CheckValidCredsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CheckValidCredsResponse extends GeneratedMessageCompanion[CheckValidCredsResponse]

Attributes

Companion:
class
Source:
CheckValidCredsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CheckValidCredsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class CreateTransferConfigRequest(parent: String, transferConfig: Option[TransferConfig], authorizationCode: String, versionInfo: String, serviceAccountName: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[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 associated with the user id corresponding to the authorization info. Otherwise, the transfer configuration will be associated with the calling user.

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 associated with the user id corresponding to the authorization info. Otherwise, the transfer configuration will be associated with the calling user.

Attributes

authorizationCode

Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: <pre class="prettyprint" suppresswarning="true"> https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var> </pre>

  • The <var>client_id</var> is the OAuth client_id of the a data source as returned by ListDataSources method.
  • <var>data_source_scopes</var> are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
parent

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

serviceAccountName

Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.

transferConfig

Required. Data transfer configuration to create.

versionInfo

Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: <pre class="prettyprint" suppresswarning="true"> https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var> </pre>

  • The <var>client_id</var> is the OAuth client_id of the a data source as returned by ListDataSources method.
  • <var>data_source_scopes</var> are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to create the transfer config.
Companion:
object
Source:
CreateTransferConfigRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CreateTransferConfigRequest extends GeneratedMessageCompanion[CreateTransferConfigRequest]

Attributes

Companion:
class
Source:
CreateTransferConfigRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateTransferConfigRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DataSource(name: String, dataSourceId: String, displayName: String, description: String, clientId: String, scopes: Seq[String], transferType: TransferType, supportsMultipleTransfers: Boolean, updateDeadlineSeconds: Int, defaultSchedule: String, supportsCustomSchedule: Boolean, parameters: Seq[DataSourceParameter], helpUrl: String, authorizationType: AuthorizationType, dataRefreshType: DataRefreshType, defaultDataRefreshWindowDays: Int, manualRunsDisabled: Boolean, minimumScheduleInterval: Option[Duration], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DataSource]

Defines the properties and custom parameters for a data source.

Defines the properties and custom parameters for a data source.

Attributes

authorizationType

Indicates the type of authorization.

clientId

Data source client id which should be used to receive refresh token.

dataRefreshType

Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.

dataSourceId

Data source id.

defaultDataRefreshWindowDays

Default data refresh window on days. Only meaningful when data_refresh_type = SLIDING_WINDOW.

defaultSchedule

Default data transfer schedule. Examples of valid schedules include: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00.

description

User friendly data source description string.

displayName

User friendly data source name.

helpUrl

Url for the help document for this data source.

manualRunsDisabled

Disables backfilling and manual run scheduling for the data source.

minimumScheduleInterval

The minimum interval for scheduler to schedule runs.

name

Output only. Data source resource name.

parameters

Data source parameters.

scopes

Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery

supportsCustomSchedule

Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to true, user can override default schedule.

supportsMultipleTransfers

Deprecated. This field has no effect.

transferType

Deprecated. This field has no effect.

updateDeadlineSeconds

The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.

Companion:
object
Source:
DataSource.scala
Graph
Supertypes
trait Updatable[DataSource]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DataSource extends GeneratedMessageCompanion[DataSource]

Attributes

Companion:
class
Source:
DataSource.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DataSource]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DataSourceParameter(paramId: String, displayName: String, description: String, `type`: Type, required: Boolean, repeated: Boolean, validationRegex: String, allowedValues: Seq[String], minValue: Option[Double], maxValue: Option[Double], fields: Seq[DataSourceParameter], validationDescription: String, validationHelpUrl: String, immutable: Boolean, recurse: Boolean, deprecated: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DataSourceParameter]

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

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

Attributes

allowedValues

All possible values for the parameter.

deprecated

If true, it should not be used in new transfers, and it should not be visible to users.

description

Parameter description.

displayName

Parameter display name in the user interface.

fields

Deprecated. This field has no effect.

immutable

Cannot be changed after initial creation.

maxValue

For integer and double values specifies maximum allowed value.

minValue

For integer and double values specifies minimum allowed value.

paramId

Parameter identifier.

recurse

Deprecated. This field has no effect.

repeated

Deprecated. This field has no effect.

required

Is parameter required.

type

Parameter type.

validationDescription

Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

validationHelpUrl

URL to a help document to further explain the naming requirements.

validationRegex

Regular expression which can be used for parameter validation.

Companion:
object
Source:
DataSourceParameter.scala
Graph
Supertypes
trait Updatable[DataSourceParameter]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DataSourceParameter extends GeneratedMessageCompanion[DataSourceParameter]

Attributes

Companion:
class
Source:
DataSourceParameter.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DataSourceParameter]
trait Serializable
class Object
trait Matchable
class Any
Self type
trait DataTransferService[F[_]]

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

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

Attributes

Companion:
object
Source:
DataTransferService.scala
Graph
Supertypes
class Object
trait Matchable
class Any
object DataTransferService

Attributes

Companion:
trait
Source:
DataTransferService.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object DatatransferProto extends GeneratedFileObject

Attributes

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

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

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

Attributes

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Companion:
object
Source:
DeleteTransferConfigRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DeleteTransferConfigRequest extends GeneratedMessageCompanion[DeleteTransferConfigRequest]

Attributes

Companion:
class
Source:
DeleteTransferConfigRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteTransferConfigRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class DeleteTransferRunRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[DeleteTransferRunRequest]

A request to delete data transfer run information.

A request to delete data transfer run information.

Attributes

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Companion:
object
Source:
DeleteTransferRunRequest.scala
Graph
Supertypes
trait Updatable[DeleteTransferRunRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DeleteTransferRunRequest extends GeneratedMessageCompanion[DeleteTransferRunRequest]

Attributes

Companion:
class
Source:
DeleteTransferRunRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteTransferRunRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class EnrollDataSourcesRequest(name: String, dataSourceIds: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[EnrollDataSourcesRequest]

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

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

Attributes

dataSourceIds

Data sources that are enrolled. It is required to provide at least one data source id.

name

The name of the project resource in the form: projects/{project_id}

Companion:
object
Source:
EnrollDataSourcesRequest.scala
Graph
Supertypes
trait Updatable[EnrollDataSourcesRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object EnrollDataSourcesRequest extends GeneratedMessageCompanion[EnrollDataSourcesRequest]

Attributes

Companion:
class
Source:
EnrollDataSourcesRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[EnrollDataSourcesRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class GetDataSourceRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetDataSourceRequest]

A request to get data source info.

A request to get data source info.

Attributes

name

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

Companion:
object
Source:
GetDataSourceRequest.scala
Graph
Supertypes
trait Updatable[GetDataSourceRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetDataSourceRequest extends GeneratedMessageCompanion[GetDataSourceRequest]

Attributes

Companion:
class
Source:
GetDataSourceRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetDataSourceRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class GetTransferConfigRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetTransferConfigRequest]

A request to get data transfer information.

A request to get data transfer information.

Attributes

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Companion:
object
Source:
GetTransferConfigRequest.scala
Graph
Supertypes
trait Updatable[GetTransferConfigRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetTransferConfigRequest extends GeneratedMessageCompanion[GetTransferConfigRequest]

Attributes

Companion:
class
Source:
GetTransferConfigRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetTransferConfigRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class GetTransferRunRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[GetTransferRunRequest]

A request to get data transfer run information.

A request to get data transfer run information.

Attributes

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Companion:
object
Source:
GetTransferRunRequest.scala
Graph
Supertypes
trait Updatable[GetTransferRunRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetTransferRunRequest extends GeneratedMessageCompanion[GetTransferRunRequest]

Attributes

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

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

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

Attributes

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 ListDataSourcesRequest list results. For multiple-page results, ListDataSourcesResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

parent

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

Companion:
object
Source:
ListDataSourcesRequest.scala
Graph
Supertypes
trait Updatable[ListDataSourcesRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListDataSourcesRequest extends GeneratedMessageCompanion[ListDataSourcesRequest]

Attributes

Companion:
class
Source:
ListDataSourcesRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListDataSourcesRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListDataSourcesResponse(dataSources: Seq[DataSource], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListDataSourcesResponse]

Returns list of supported data sources and their metadata.

Returns list of supported data sources and their metadata.

Attributes

dataSources

List of supported data sources and their transfer settings.

nextPageToken

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

Companion:
object
Source:
ListDataSourcesResponse.scala
Graph
Supertypes
trait Updatable[ListDataSourcesResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListDataSourcesResponse extends GeneratedMessageCompanion[ListDataSourcesResponse]

Attributes

Companion:
class
Source:
ListDataSourcesResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListDataSourcesResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListTransferConfigsRequest(parent: String, dataSourceIds: Seq[String], pageToken: String, pageSize: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListTransferConfigsRequest]

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

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

Attributes

dataSourceIds

When specified, only configurations of requested data sources are returned.

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 ListTransfersRequest list results. For multiple-page results, ListTransfersResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

parent

Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

Companion:
object
Source:
ListTransferConfigsRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListTransferConfigsRequest extends GeneratedMessageCompanion[ListTransferConfigsRequest]

Attributes

Companion:
class
Source:
ListTransferConfigsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListTransferConfigsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListTransferConfigsResponse(transferConfigs: Seq[TransferConfig], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListTransferConfigsResponse]

The returned list of pipelines in the project.

The returned list of pipelines in the project.

Attributes

nextPageToken

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

transferConfigs

Output only. The stored pipeline transfer configurations.

Companion:
object
Source:
ListTransferConfigsResponse.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListTransferConfigsResponse extends GeneratedMessageCompanion[ListTransferConfigsResponse]

Attributes

Companion:
class
Source:
ListTransferConfigsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListTransferConfigsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListTransferLogsRequest(parent: String, pageToken: String, pageSize: Int, messageTypes: Seq[MessageSeverity], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListTransferLogsRequest]

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

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

Attributes

messageTypes

Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

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 ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

parent

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Companion:
object
Source:
ListTransferLogsRequest.scala
Graph
Supertypes
trait Updatable[ListTransferLogsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListTransferLogsRequest extends GeneratedMessageCompanion[ListTransferLogsRequest]

Attributes

Companion:
class
Source:
ListTransferLogsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListTransferLogsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListTransferLogsResponse(transferMessages: Seq[TransferMessage], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListTransferLogsResponse]

The returned list transfer run messages.

The returned list transfer run messages.

Attributes

nextPageToken

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

transferMessages

Output only. The stored pipeline transfer messages.

Companion:
object
Source:
ListTransferLogsResponse.scala
Graph
Supertypes
trait Updatable[ListTransferLogsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListTransferLogsResponse extends GeneratedMessageCompanion[ListTransferLogsResponse]

Attributes

Companion:
class
Source:
ListTransferLogsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListTransferLogsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListTransferRunsRequest(parent: String, states: Seq[TransferState], pageToken: String, pageSize: Int, runAttempt: RunAttempt, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListTransferRunsRequest]

A request to list data transfer runs.

A request to list data transfer runs.

Attributes

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 ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

parent

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

runAttempt

Indicates how run attempts are to be pulled.

states

When specified, only transfer runs with requested states are returned.

Companion:
object
Source:
ListTransferRunsRequest.scala
Graph
Supertypes
trait Updatable[ListTransferRunsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListTransferRunsRequest extends GeneratedMessageCompanion[ListTransferRunsRequest]

Attributes

Companion:
class
Source:
ListTransferRunsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListTransferRunsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ListTransferRunsResponse(transferRuns: Seq[TransferRun], nextPageToken: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ListTransferRunsResponse]

The returned list of pipelines in the project.

The returned list of pipelines in the project.

Attributes

nextPageToken

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

transferRuns

Output only. The stored pipeline transfer runs.

Companion:
object
Source:
ListTransferRunsResponse.scala
Graph
Supertypes
trait Updatable[ListTransferRunsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ListTransferRunsResponse extends GeneratedMessageCompanion[ListTransferRunsResponse]

Attributes

Companion:
class
Source:
ListTransferRunsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListTransferRunsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ScheduleTransferRunsRequest(parent: String, startTime: Option[Timestamp], endTime: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ScheduleTransferRunsRequest]

A request to schedule transfer runs for a time range.

A request to schedule transfer runs for a time range.

Attributes

endTime

Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".

parent

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

startTime

Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".

Companion:
object
Source:
ScheduleTransferRunsRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ScheduleTransferRunsRequest extends GeneratedMessageCompanion[ScheduleTransferRunsRequest]

Attributes

Companion:
class
Source:
ScheduleTransferRunsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ScheduleTransferRunsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class ScheduleTransferRunsResponse(runs: Seq[TransferRun], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[ScheduleTransferRunsResponse]

A response to schedule transfer runs for a time range.

A response to schedule transfer runs for a time range.

Attributes

runs

The transfer runs that were scheduled.

Companion:
object
Source:
ScheduleTransferRunsResponse.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ScheduleTransferRunsResponse extends GeneratedMessageCompanion[ScheduleTransferRunsResponse]

Attributes

Companion:
class
Source:
ScheduleTransferRunsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ScheduleTransferRunsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class StartManualTransferRunsRequest(parent: String, time: Time, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[StartManualTransferRunsRequest]

A request to start manual transfer runs.

A request to start manual transfer runs.

Attributes

parent

Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

Companion:
object
Source:
StartManualTransferRunsRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object StartManualTransferRunsRequest extends GeneratedMessageCompanion[StartManualTransferRunsRequest]

Attributes

Companion:
class
Source:
StartManualTransferRunsRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[StartManualTransferRunsRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class StartManualTransferRunsResponse(runs: Seq[TransferRun], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[StartManualTransferRunsResponse]

A response to start manual transfer runs.

A response to start manual transfer runs.

Attributes

runs

The transfer runs that were created.

Companion:
object
Source:
StartManualTransferRunsResponse.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object StartManualTransferRunsResponse extends GeneratedMessageCompanion[StartManualTransferRunsResponse]

Attributes

Companion:
class
Source:
StartManualTransferRunsResponse.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[StartManualTransferRunsResponse]
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class UpdateTransferConfigRequest(transferConfig: Option[TransferConfig], authorizationCode: String, updateMask: Option[FieldMask], versionInfo: String, serviceAccountName: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[UpdateTransferConfigRequest]

A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.

A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.

Attributes

authorizationCode

Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL: <pre class="prettyprint" suppresswarning="true"> https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var> </pre>

  • The <var>client_id</var> is the OAuth client_id of the a data source as returned by ListDataSources method.
  • <var>data_source_scopes</var> are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to update the transfer config.
serviceAccountName

Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.

transferConfig

Required. Data transfer configuration to create.

updateMask

Required. Required list of fields to be updated in this request.

versionInfo

Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL: <pre class="prettyprint" suppresswarning="true"> https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var> </pre>

  • The <var>client_id</var> is the OAuth client_id of the a data source as returned by ListDataSources method.
  • <var>data_source_scopes</var> are the scopes returned by ListDataSources method. Note that this should not be set when service_account_name is used to update the transfer config.
Companion:
object
Source:
UpdateTransferConfigRequest.scala
Graph
Supertypes
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object UpdateTransferConfigRequest extends GeneratedMessageCompanion[UpdateTransferConfigRequest]

Attributes

Companion:
class
Source:
UpdateTransferConfigRequest.scala
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateTransferConfigRequest]
trait Serializable
class Object
trait Matchable
class Any
Self type
Generated with