public interface CreateTransferConfigRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAuthorizationCode()
public abstract String getAuthorizationCode() Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
CheckValidCreds.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
string authorization_code = 3;
| Type | Description |
| String | The authorizationCode. |
getAuthorizationCodeBytes()
public abstract ByteString getAuthorizationCodeBytes() Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
CheckValidCreds.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
string authorization_code = 3;
| 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) = { ... }
| 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) = { ... }
| Type | Description |
| ByteString | The bytes for parent. |
getServiceAccountName()
public abstract String getServiceAccountName()Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
string service_account_name = 6;
| Type | Description |
| String | The serviceAccountName. |
getServiceAccountNameBytes()
public abstract ByteString getServiceAccountNameBytes()Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
string service_account_name = 6;
| 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];
| 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];
| Type | Description |
| TransferConfigOrBuilder |
getVersionInfo()
public abstract String getVersionInfo()Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
string version_info = 5;
| Type | Description |
| String | The versionInfo. |
getVersionInfoBytes()
public abstract ByteString getVersionInfoBytes()Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
string version_info = 5;
| 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];
| Type | Description |
| boolean | Whether the transferConfig field is set. |