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

Class CreateTransferConfigRequest.Builder

  • All Implemented Interfaces:
    CreateTransferConfigRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    CreateTransferConfigRequest
    public static final class CreateTransferConfigRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferConfigRequest.Builder>
implements CreateTransferConfigRequestOrBuilder
     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.
    Protobuf type google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferConfigRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferConfigRequest.Builder>

      • getDefaultInstanceForType

        public CreateTransferConfigRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public CreateTransferConfigRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public CreateTransferConfigRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferConfigRequest.Builder>

      • mergeFrom

        public CreateTransferConfigRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CreateTransferConfigRequest.Builder>
        Throws:
        IOException

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface CreateTransferConfigRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface CreateTransferConfigRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public CreateTransferConfigRequest.Builder setParent​(String value)
         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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public CreateTransferConfigRequest.Builder clearParent()
         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:
        This builder for chaining.

      • setParentBytes

        public CreateTransferConfigRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • hasTransferConfig

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

      • getTransferConfig

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

      • setTransferConfig

        public CreateTransferConfigRequest.Builder setTransferConfig​(TransferConfig value)
         Required. Data transfer configuration to create.
        .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];

      • setTransferConfig

        public CreateTransferConfigRequest.Builder setTransferConfig​(TransferConfig.Builder builderForValue)
         Required. Data transfer configuration to create.
        .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];

      • mergeTransferConfig

        public CreateTransferConfigRequest.Builder mergeTransferConfig​(TransferConfig value)
         Required. Data transfer configuration to create.
        .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];

      • clearTransferConfig

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

      • getTransferConfigBuilder

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

      • getAuthorizationCode

        public 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;
        Specified by:
        getAuthorizationCode in interface CreateTransferConfigRequestOrBuilder
        Returns:
        The authorizationCode.

      • getAuthorizationCodeBytes

        public 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;
        Specified by:
        getAuthorizationCodeBytes in interface CreateTransferConfigRequestOrBuilder
        Returns:
        The bytes for authorizationCode.

      • setAuthorizationCode

        public CreateTransferConfigRequest.Builder setAuthorizationCode​(String value)
         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;
        Parameters:
        value - The authorizationCode to set.
        Returns:
        This builder for chaining.

      • clearAuthorizationCode

        public CreateTransferConfigRequest.Builder clearAuthorizationCode()
         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:
        This builder for chaining.

      • setAuthorizationCodeBytes

        public CreateTransferConfigRequest.Builder setAuthorizationCodeBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for authorizationCode to set.
        Returns:
        This builder for chaining.

      • getVersionInfo

        public 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;
        Specified by:
        getVersionInfo in interface CreateTransferConfigRequestOrBuilder
        Returns:
        The versionInfo.

      • getVersionInfoBytes

        public 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;
        Specified by:
        getVersionInfoBytes in interface CreateTransferConfigRequestOrBuilder
        Returns:
        The bytes for versionInfo.

      • setVersionInfo

        public CreateTransferConfigRequest.Builder setVersionInfo​(String value)
         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;
        Parameters:
        value - The versionInfo to set.
        Returns:
        This builder for chaining.

      • clearVersionInfo

        public CreateTransferConfigRequest.Builder clearVersionInfo()
         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:
        This builder for chaining.

      • setVersionInfoBytes

        public CreateTransferConfigRequest.Builder setVersionInfoBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for versionInfo to set.
        Returns:
        This builder for chaining.

      • getServiceAccountName

        public 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;
        Specified by:
        getServiceAccountName in interface CreateTransferConfigRequestOrBuilder
        Returns:
        The serviceAccountName.

      • getServiceAccountNameBytes

        public 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;
        Specified by:
        getServiceAccountNameBytes in interface CreateTransferConfigRequestOrBuilder
        Returns:
        The bytes for serviceAccountName.

      • setServiceAccountName

        public CreateTransferConfigRequest.Builder setServiceAccountName​(String value)
         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;
        Parameters:
        value - The serviceAccountName to set.
        Returns:
        This builder for chaining.

      • clearServiceAccountName

        public CreateTransferConfigRequest.Builder clearServiceAccountName()
         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:
        This builder for chaining.

      • setServiceAccountNameBytes

        public CreateTransferConfigRequest.Builder setServiceAccountNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for serviceAccountName to set.
        Returns:
        This builder for chaining.

      • mergeUnknownFields

        public final CreateTransferConfigRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CreateTransferConfigRequest.Builder>