Interface CreateTransferConfigRequestOrBuilder (2.53.0) 

public interface CreateTransferConfigRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthorizationCode() (deprecated)

public abstract String getAuthorizationCode()

Deprecated. google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=537

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

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://bigquery.cloud.google.com/datatransfer/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 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.

string authorization_code = 3 [deprecated = true];

Returns
Type Description
String

The authorizationCode.

getAuthorizationCodeBytes() (deprecated)

public abstract ByteString getAuthorizationCodeBytes()

Deprecated. google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=537

Deprecated: Authorization code was required when transferConfig.dataSourceId is 'youtube_channel' but it is no longer used in any data sources. Use version_info instead.

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://bigquery.cloud.google.com/datatransfer/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 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.

string authorization_code = 3 [deprecated = true];

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 parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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://bigquery.cloud.google.com/datatransfer/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 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.

string version_info = 5;

Returns
Type Description
String

The versionInfo.

getVersionInfoBytes()

public abstract ByteString getVersionInfoBytes()

Optional version info. This parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is 'youtube_channel' or 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://bigquery.cloud.google.com/datatransfer/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 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.

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.