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

Interface CreateTransferConfigRequestOrBuilder

    • Method Detail

      • getParent

        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:
        The parent.

      • getParentBytes

        com.google.protobuf.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:
        The bytes for parent.

      • hasTransferConfig

        boolean hasTransferConfig()
         Required. Data transfer configuration to create.
        .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the transferConfig field is set.

      • getTransferConfig

        TransferConfig getTransferConfig()
         Required. Data transfer configuration to create.
        .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The transferConfig.

      • getTransferConfigOrBuilder

        TransferConfigOrBuilder getTransferConfigOrBuilder()
         Required. Data transfer configuration to create.
        .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];

      • getAuthorizationCode

        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_name` is used to
 create the transfer config.
        string authorization_code = 3;
        Returns:
        The authorizationCode.

      • getAuthorizationCodeBytes

        com.google.protobuf.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_name` is used to
 create the transfer config.
        string authorization_code = 3;
        Returns:
        The bytes for authorizationCode.

      • getVersionInfo

        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_name` is used to
 create the transfer config.
        string version_info = 5;
        Returns:
        The versionInfo.

      • getVersionInfoBytes

        com.google.protobuf.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_name` is used to
 create the transfer config.
        string version_info = 5;
        Returns:
        The bytes for versionInfo.

      • getServiceAccountName

        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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
        string service_account_name = 6;
        Returns:
        The serviceAccountName.

      • getServiceAccountNameBytes

        com.google.protobuf.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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
        string service_account_name = 6;
        Returns:
        The bytes for serviceAccountName.