com.google.cloud.bigquery.datatransfer.v1.datatransfer
Members list
Type members
Classlikes
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.
Value parameters
- name
-
Required. The data source in the form:
projects/{project_id}/dataSources/{data_source_id}
orprojects/{project_id}/locations/{location_id}/dataSources/{data_source_id}
.
Attributes
- Companion
- object
- Source
- CheckValidCredsRequest.scala
- Supertypes
-
trait Updatable[CheckValidCredsRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- CheckValidCredsRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[CheckValidCredsRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A response indicating whether the credentials exist and are valid.
A response indicating whether the credentials exist and are valid.
Value parameters
- hasValidCreds
-
If set to
true
, the credentials exist and are valid.
Attributes
- Companion
- object
- Source
- CheckValidCredsResponse.scala
- Supertypes
-
trait Updatable[CheckValidCredsResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- CheckValidCredsResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[CheckValidCredsResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
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.
Value parameters
- 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 byCheckValidCreds
. 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 byCheckValidCreds
. 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.
Attributes
- Companion
- object
- Source
- CreateTransferConfigRequest.scala
- Supertypes
-
trait Updatable[CreateTransferConfigRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- CreateTransferConfigRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[CreateTransferConfigRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Defines the properties and custom parameters for a data source.
Defines the properties and custom parameters for a data source.
Value parameters
- 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
, andfirst 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.
Attributes
- Companion
- object
- Source
- DataSource.scala
- Supertypes
-
trait Updatable[DataSource]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- DataSource.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[DataSource]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
DataSource.type
A parameter used to define custom fields in a data source definition.
A parameter used to define custom fields in a data source definition.
Value parameters
- 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.
Attributes
- Companion
- object
- Source
- DataSourceParameter.scala
- Supertypes
-
trait Updatable[DataSourceParameter]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- DataSourceParameter.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[DataSourceParameter]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
DataSourceParameter.type
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
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Source
- DataTransferService.scala
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
DataTransferService.type
Attributes
- Source
- DatatransferProto.scala
- Supertypes
-
class GeneratedFileObjectclass Objecttrait Matchableclass Any
- Self type
-
DatatransferProto.type
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.
Value parameters
- name
-
Required. The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
Attributes
- Companion
- object
- Source
- DeleteTransferConfigRequest.scala
- Supertypes
-
trait Updatable[DeleteTransferConfigRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- DeleteTransferConfigRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[DeleteTransferConfigRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A request to delete data transfer run information.
A request to delete data transfer run information.
Value parameters
- name
-
Required. The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
Attributes
- Companion
- object
- Source
- DeleteTransferRunRequest.scala
- Supertypes
-
trait Updatable[DeleteTransferRunRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- DeleteTransferRunRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[DeleteTransferRunRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
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.
Value parameters
- 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}
Attributes
- Companion
- object
- Source
- EnrollDataSourcesRequest.scala
- Supertypes
-
trait Updatable[EnrollDataSourcesRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- EnrollDataSourcesRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[EnrollDataSourcesRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A request to get data source info.
A request to get data source info.
Value parameters
- name
-
Required. The field will contain name of the resource requested, for example:
projects/{project_id}/dataSources/{data_source_id}
orprojects/{project_id}/locations/{location_id}/dataSources/{data_source_id}
Attributes
- Companion
- object
- Source
- GetDataSourceRequest.scala
- Supertypes
-
trait Updatable[GetDataSourceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- GetDataSourceRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[GetDataSourceRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
GetDataSourceRequest.type
A request to get data transfer information.
A request to get data transfer information.
Value parameters
- name
-
Required. The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
Attributes
- Companion
- object
- Source
- GetTransferConfigRequest.scala
- Supertypes
-
trait Updatable[GetTransferConfigRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- GetTransferConfigRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[GetTransferConfigRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A request to get data transfer run information.
A request to get data transfer run information.
Value parameters
- name
-
Required. The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
Attributes
- Companion
- object
- Source
- GetTransferRunRequest.scala
- Supertypes
-
trait Updatable[GetTransferRunRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- GetTransferRunRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[GetTransferRunRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Request to list supported data sources and their data transfer settings.
Request to list supported data sources and their data transfer settings.
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
ListDataSourcesRequest
list results. For multiple-page results,ListDataSourcesResponse
outputs anext_page
token, which can be used as thepage_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}
orprojects/{project_id}/locations/{location_id}
Attributes
- Companion
- object
- Source
- ListDataSourcesRequest.scala
- Supertypes
-
trait Updatable[ListDataSourcesRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListDataSourcesRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListDataSourcesRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
Returns list of supported data sources and their metadata.
Returns list of supported data sources and their metadata.
Value parameters
- 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.
Attributes
- Companion
- object
- Source
- ListDataSourcesResponse.scala
- Supertypes
-
trait Updatable[ListDataSourcesResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListDataSourcesResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListDataSourcesResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A request to list data transfers configured for a BigQuery project.
A request to list data transfers configured for a BigQuery project.
Value parameters
- 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 anext_page
token, which can be used as thepage_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}
orprojects/{project_id}/locations/{location_id}
Attributes
- Companion
- object
- Source
- ListTransferConfigsRequest.scala
- Supertypes
-
trait Updatable[ListTransferConfigsRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListTransferConfigsRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListTransferConfigsRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
The returned list of pipelines in the project.
The returned list of pipelines in the project.
Value parameters
- 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.
Attributes
- Companion
- object
- Source
- ListTransferConfigsResponse.scala
- Supertypes
-
trait Updatable[ListTransferConfigsResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListTransferConfigsResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListTransferConfigsResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
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.
Value parameters
- 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 anext_page
token, which can be used as thepage_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}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
Attributes
- Companion
- object
- Source
- ListTransferLogsRequest.scala
- Supertypes
-
trait Updatable[ListTransferLogsRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListTransferLogsRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListTransferLogsRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
The returned list transfer run messages.
The returned list transfer run messages.
Value parameters
- 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.
Attributes
- Companion
- object
- Source
- ListTransferLogsResponse.scala
- Supertypes
-
trait Updatable[ListTransferLogsResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListTransferLogsResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListTransferLogsResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A request to list data transfer runs.
A request to list data transfer runs.
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
ListTransferRunsRequest
list results. For multiple-page results,ListTransferRunsResponse
outputs anext_page
token, which can be used as thepage_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}
orprojects/{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.
Attributes
- Companion
- object
- Source
- ListTransferRunsRequest.scala
- Supertypes
-
trait Updatable[ListTransferRunsRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListTransferRunsRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListTransferRunsRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
The returned list of pipelines in the project.
The returned list of pipelines in the project.
Value parameters
- 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.
Attributes
- Companion
- object
- Source
- ListTransferRunsResponse.scala
- Supertypes
-
trait Updatable[ListTransferRunsResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ListTransferRunsResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ListTransferRunsResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A request to schedule transfer runs for a time range.
A request to schedule transfer runs for a time range.
Value parameters
- 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}
orprojects/{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"
.
Attributes
- Companion
- object
- Source
- ScheduleTransferRunsRequest.scala
- Supertypes
-
trait Updatable[ScheduleTransferRunsRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ScheduleTransferRunsRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ScheduleTransferRunsRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A response to schedule transfer runs for a time range.
A response to schedule transfer runs for a time range.
Value parameters
- runs
-
The transfer runs that were scheduled.
Attributes
- Companion
- object
- Source
- ScheduleTransferRunsResponse.scala
- Supertypes
-
trait Updatable[ScheduleTransferRunsResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- ScheduleTransferRunsResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[ScheduleTransferRunsResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A request to start manual transfer runs.
A request to start manual transfer runs.
Value parameters
- parent
-
Transfer configuration name in the form:
projects/{project_id}/transferConfigs/{config_id}
orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
.
Attributes
- Companion
- object
- Source
- StartManualTransferRunsRequest.scala
- Supertypes
-
trait Updatable[StartManualTransferRunsRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- StartManualTransferRunsRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[StartManualTransferRunsRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
A response to start manual transfer runs.
A response to start manual transfer runs.
Value parameters
- runs
-
The transfer runs that were created.
Attributes
- Companion
- object
- Source
- StartManualTransferRunsResponse.scala
- Supertypes
-
trait Updatable[StartManualTransferRunsResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- StartManualTransferRunsResponse.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[StartManualTransferRunsResponse]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
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.
Value parameters
- 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 byCheckValidCreds
. 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 byCheckValidCreds
. 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.
Attributes
- Companion
- object
- Source
- UpdateTransferConfigRequest.scala
- Supertypes
-
trait Updatable[UpdateTransferConfigRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Source
- UpdateTransferConfigRequest.scala
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[UpdateTransferConfigRequest]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type