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

Class CloudSpannerProperties

  • All Implemented Interfaces:
    CloudSpannerPropertiesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CloudSpannerProperties
extends com.google.protobuf.GeneratedMessageV3
implements CloudSpannerPropertiesOrBuilder
     Connection properties specific to Cloud Spanner.
    Protobuf type google.cloud.bigquery.connection.v1.CloudSpannerProperties
    See Also:
    Serialized Form

    • Field Detail

      • USE_PARALLELISM_FIELD_NUMBER

        public static final int USE_PARALLELISM_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_PARALLELISM_FIELD_NUMBER

        public static final int MAX_PARALLELISM_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_SERVERLESS_ANALYTICS_FIELD_NUMBER

        public static final int USE_SERVERLESS_ANALYTICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USE_DATA_BOOST_FIELD_NUMBER

        public static final int USE_DATA_BOOST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATABASE_ROLE_FIELD_NUMBER

        public static final int DATABASE_ROLE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

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

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

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

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

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

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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CloudSpannerProperties parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudSpannerProperties parseFrom​(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudSpannerProperties parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudSpannerProperties parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudSpannerProperties parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CloudSpannerProperties parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected CloudSpannerProperties.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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

      • getDefaultInstanceForType

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