- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.17
- 2.2.6
- 2.1.23
- 2.0.27
public interface CreateTransferConfigRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAuthorizationCode()
public abstract String getAuthorizationCode() 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_nameis used to create the transfer config.
string authorization_code = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The authorizationCode. |
getAuthorizationCodeBytes()
public abstract ByteString getAuthorizationCodeBytes() 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_nameis used to create the transfer config.
string authorization_code = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for authorizationCode. |
getParent()
public abstract String getParent()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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes()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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getServiceAccountName()
public abstract String getServiceAccountName()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.
string service_account_name = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccountName. |
getServiceAccountNameBytes()
public abstract ByteString getServiceAccountNameBytes()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.
string service_account_name = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccountName. |
getTransferConfig()
public abstract TransferConfig getTransferConfig()Required. Data transfer configuration to create.
.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TransferConfig |
The transferConfig. |
getTransferConfigOrBuilder()
public abstract TransferConfigOrBuilder getTransferConfigOrBuilder()Required. Data transfer configuration to create.
.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TransferConfigOrBuilder |
|
getVersionInfo()
public abstract String getVersionInfo() 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_nameis used to create the transfer config.
string version_info = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The versionInfo. |
getVersionInfoBytes()
public abstract ByteString getVersionInfoBytes() 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_nameis used to create the transfer config.
string version_info = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for versionInfo. |
hasTransferConfig()
public abstract boolean hasTransferConfig()Required. Data transfer configuration to create.
.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the transferConfig field is set. |