Package com.google.cloud.bigquery.connection.v1

Class CloudSpannerProperties.Builder

    • 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<CloudSpannerProperties.Builder>

      • clear

        public CloudSpannerProperties.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<CloudSpannerProperties.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<CloudSpannerProperties.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public CloudSpannerProperties.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<CloudSpannerProperties.Builder>

      • clearField

        public CloudSpannerProperties.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CloudSpannerProperties.Builder>

      • clearOneof

        public CloudSpannerProperties.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CloudSpannerProperties.Builder>

      • setRepeatedField

        public CloudSpannerProperties.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CloudSpannerProperties.Builder>

      • addRepeatedField

        public CloudSpannerProperties.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CloudSpannerProperties.Builder>

      • isInitialized

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

      • mergeFrom

        public CloudSpannerProperties.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<CloudSpannerProperties.Builder>
        Throws:
        IOException

      • getDatabaseBytes

        public com.google.protobuf.ByteString getDatabaseBytes()
         Cloud Spanner database in the form `project/instance/database'
        string database = 1;
        Specified by:
        getDatabaseBytes in interface CloudSpannerPropertiesOrBuilder
        Returns:
        The bytes for database.

      • setDatabase

        public CloudSpannerProperties.Builder setDatabase​(String value)
         Cloud Spanner database in the form `project/instance/database'
        string database = 1;
        Parameters:
        value - The database to set.
        Returns:
        This builder for chaining.

      • clearDatabase

        public CloudSpannerProperties.Builder clearDatabase()
         Cloud Spanner database in the form `project/instance/database'
        string database = 1;
        Returns:
        This builder for chaining.

      • setDatabaseBytes

        public CloudSpannerProperties.Builder setDatabaseBytes​(com.google.protobuf.ByteString value)
         Cloud Spanner database in the form `project/instance/database'
        string database = 1;
        Parameters:
        value - The bytes for database to set.
        Returns:
        This builder for chaining.

      • getUseParallelism

        public boolean getUseParallelism()
         If parallelism should be used when reading from Cloud Spanner
        bool use_parallelism = 2;
        Specified by:
        getUseParallelism in interface CloudSpannerPropertiesOrBuilder
        Returns:
        The useParallelism.

      • setUseParallelism

        public CloudSpannerProperties.Builder setUseParallelism​(boolean value)
         If parallelism should be used when reading from Cloud Spanner
        bool use_parallelism = 2;
        Parameters:
        value - The useParallelism to set.
        Returns:
        This builder for chaining.

      • clearUseParallelism

        public CloudSpannerProperties.Builder clearUseParallelism()
         If parallelism should be used when reading from Cloud Spanner
        bool use_parallelism = 2;
        Returns:
        This builder for chaining.

      • getMaxParallelism

        public int getMaxParallelism()
         Allows setting max parallelism per query when executing on Spanner
 independent compute resources. If unspecified, default values of
 parallelism are chosen that are dependent on the Cloud Spanner instance
 configuration.

 REQUIRES: `use_parallelism` must be set.
 REQUIRES: Either `use_data_boost` or `use_serverless_analytics` must be
 set.
        int32 max_parallelism = 5;
        Specified by:
        getMaxParallelism in interface CloudSpannerPropertiesOrBuilder
        Returns:
        The maxParallelism.

      • setMaxParallelism

        public CloudSpannerProperties.Builder setMaxParallelism​(int value)
         Allows setting max parallelism per query when executing on Spanner
 independent compute resources. If unspecified, default values of
 parallelism are chosen that are dependent on the Cloud Spanner instance
 configuration.

 REQUIRES: `use_parallelism` must be set.
 REQUIRES: Either `use_data_boost` or `use_serverless_analytics` must be
 set.
        int32 max_parallelism = 5;
        Parameters:
        value - The maxParallelism to set.
        Returns:
        This builder for chaining.

      • clearMaxParallelism

        public CloudSpannerProperties.Builder clearMaxParallelism()
         Allows setting max parallelism per query when executing on Spanner
 independent compute resources. If unspecified, default values of
 parallelism are chosen that are dependent on the Cloud Spanner instance
 configuration.

 REQUIRES: `use_parallelism` must be set.
 REQUIRES: Either `use_data_boost` or `use_serverless_analytics` must be
 set.
        int32 max_parallelism = 5;
        Returns:
        This builder for chaining.

      • getUseServerlessAnalytics

        public boolean getUseServerlessAnalytics()
         If the serverless analytics service should be used to read data from Cloud
 Spanner.
 Note: `use_parallelism` must be set when using serverless analytics.
        bool use_serverless_analytics = 3;
        Specified by:
        getUseServerlessAnalytics in interface CloudSpannerPropertiesOrBuilder
        Returns:
        The useServerlessAnalytics.

      • setUseServerlessAnalytics

        public CloudSpannerProperties.Builder setUseServerlessAnalytics​(boolean value)
         If the serverless analytics service should be used to read data from Cloud
 Spanner.
 Note: `use_parallelism` must be set when using serverless analytics.
        bool use_serverless_analytics = 3;
        Parameters:
        value - The useServerlessAnalytics to set.
        Returns:
        This builder for chaining.

      • clearUseServerlessAnalytics

        public CloudSpannerProperties.Builder clearUseServerlessAnalytics()
         If the serverless analytics service should be used to read data from Cloud
 Spanner.
 Note: `use_parallelism` must be set when using serverless analytics.
        bool use_serverless_analytics = 3;
        Returns:
        This builder for chaining.

      • getUseDataBoost

        public boolean getUseDataBoost()
         If set, the request will be executed via Spanner independent compute
 resources.
 REQUIRES: `use_parallelism` must be set.

 NOTE: `use_serverless_analytics` will be deprecated. Prefer
 `use_data_boost` over `use_serverless_analytics`.
        bool use_data_boost = 6;
        Specified by:
        getUseDataBoost in interface CloudSpannerPropertiesOrBuilder
        Returns:
        The useDataBoost.

      • setUseDataBoost

        public CloudSpannerProperties.Builder setUseDataBoost​(boolean value)
         If set, the request will be executed via Spanner independent compute
 resources.
 REQUIRES: `use_parallelism` must be set.

 NOTE: `use_serverless_analytics` will be deprecated. Prefer
 `use_data_boost` over `use_serverless_analytics`.
        bool use_data_boost = 6;
        Parameters:
        value - The useDataBoost to set.
        Returns:
        This builder for chaining.

      • clearUseDataBoost

        public CloudSpannerProperties.Builder clearUseDataBoost()
         If set, the request will be executed via Spanner independent compute
 resources.
 REQUIRES: `use_parallelism` must be set.

 NOTE: `use_serverless_analytics` will be deprecated. Prefer
 `use_data_boost` over `use_serverless_analytics`.
        bool use_data_boost = 6;
        Returns:
        This builder for chaining.

      • getDatabaseRole

        public String getDatabaseRole()
         Optional. Cloud Spanner database role for fine-grained access control.
 The Cloud Spanner admin should have provisioned the database role with
 appropriate permissions, such as `SELECT` and `INSERT`. Other users should
 only use roles provided by their Cloud Spanner admins.

 For more details, see [About fine-grained access control]
 (https://cloud.google.com/spanner/docs/fgac-about).

 REQUIRES: The database role name must start with a letter, and can only
 contain letters, numbers, and underscores.
        string database_role = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDatabaseRole in interface CloudSpannerPropertiesOrBuilder
        Returns:
        The databaseRole.

      • getDatabaseRoleBytes

        public com.google.protobuf.ByteString getDatabaseRoleBytes()
         Optional. Cloud Spanner database role for fine-grained access control.
 The Cloud Spanner admin should have provisioned the database role with
 appropriate permissions, such as `SELECT` and `INSERT`. Other users should
 only use roles provided by their Cloud Spanner admins.

 For more details, see [About fine-grained access control]
 (https://cloud.google.com/spanner/docs/fgac-about).

 REQUIRES: The database role name must start with a letter, and can only
 contain letters, numbers, and underscores.
        string database_role = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDatabaseRoleBytes in interface CloudSpannerPropertiesOrBuilder
        Returns:
        The bytes for databaseRole.

      • setDatabaseRole

        public CloudSpannerProperties.Builder setDatabaseRole​(String value)
         Optional. Cloud Spanner database role for fine-grained access control.
 The Cloud Spanner admin should have provisioned the database role with
 appropriate permissions, such as `SELECT` and `INSERT`. Other users should
 only use roles provided by their Cloud Spanner admins.

 For more details, see [About fine-grained access control]
 (https://cloud.google.com/spanner/docs/fgac-about).

 REQUIRES: The database role name must start with a letter, and can only
 contain letters, numbers, and underscores.
        string database_role = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The databaseRole to set.
        Returns:
        This builder for chaining.

      • clearDatabaseRole

        public CloudSpannerProperties.Builder clearDatabaseRole()
         Optional. Cloud Spanner database role for fine-grained access control.
 The Cloud Spanner admin should have provisioned the database role with
 appropriate permissions, such as `SELECT` and `INSERT`. Other users should
 only use roles provided by their Cloud Spanner admins.

 For more details, see [About fine-grained access control]
 (https://cloud.google.com/spanner/docs/fgac-about).

 REQUIRES: The database role name must start with a letter, and can only
 contain letters, numbers, and underscores.
        string database_role = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setDatabaseRoleBytes

        public CloudSpannerProperties.Builder setDatabaseRoleBytes​(com.google.protobuf.ByteString value)
         Optional. Cloud Spanner database role for fine-grained access control.
 The Cloud Spanner admin should have provisioned the database role with
 appropriate permissions, such as `SELECT` and `INSERT`. Other users should
 only use roles provided by their Cloud Spanner admins.

 For more details, see [About fine-grained access control]
 (https://cloud.google.com/spanner/docs/fgac-about).

 REQUIRES: The database role name must start with a letter, and can only
 contain letters, numbers, and underscores.
        string database_role = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for databaseRole to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

        public final CloudSpannerProperties.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<CloudSpannerProperties.Builder>