Class CloudSpannerProperties (2.20.0) 

public final class CloudSpannerProperties extends GeneratedMessageV3 implements CloudSpannerPropertiesOrBuilder

Connection properties specific to Cloud Spanner.

Protobuf type google.cloud.bigquery.connection.v1.CloudSpannerProperties

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CloudSpannerProperties

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_ROLE_FIELD_NUMBER

public static final int DATABASE_ROLE_FIELD_NUMBER
Field Value
Type Description
int

USE_PARALLELISM_FIELD_NUMBER

public static final int USE_PARALLELISM_FIELD_NUMBER
Field Value
Type Description
int

USE_SERVERLESS_ANALYTICS_FIELD_NUMBER

public static final int USE_SERVERLESS_ANALYTICS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CloudSpannerProperties getDefaultInstance()
Returns
Type Description
CloudSpannerProperties

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CloudSpannerProperties.Builder newBuilder()
Returns
Type Description
CloudSpannerProperties.Builder

newBuilder(CloudSpannerProperties prototype)

public static CloudSpannerProperties.Builder newBuilder(CloudSpannerProperties prototype)
Parameter
Name Description
prototype CloudSpannerProperties
Returns
Type Description
CloudSpannerProperties.Builder

parseDelimitedFrom(InputStream input)

public static CloudSpannerProperties parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudSpannerProperties parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CloudSpannerProperties parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CloudSpannerProperties parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CloudSpannerProperties parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CloudSpannerProperties parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CloudSpannerProperties parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudSpannerProperties parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CloudSpannerProperties parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloudSpannerProperties parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CloudSpannerProperties parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CloudSpannerProperties parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloudSpannerProperties
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CloudSpannerProperties> parser()
Returns
Type Description
Parser<CloudSpannerProperties>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatabase()

public String getDatabase()

Cloud Spanner database in the form `project/instance/database'

string database = 1;

Returns
Type Description
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Cloud Spanner database in the form `project/instance/database'

string database = 1;

Returns
Type Description
ByteString

The bytes for database.

getDatabaseRole()

public String getDatabaseRole()

Optional. Cloud Spanner database role for fine-grained access control. A database role is a collection of fine-grained access privileges. Example: Admin predefines roles that provides user a set of permissions (SELECT, INSERT, ..). The user can then specify a predefined role on a connection to execute their Cloud Spanner query. The role is passthrough here. If the user is not authorized to use the specified role, they get an error. This validation happens on Cloud Spanner. See https://cloud.google.com/spanner/docs/fgac-about for more details. REQUIRES: database role name must start with uppercase/lowercase letter and only contain uppercase/lowercase letters, numbers, and underscores.

string database_role = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The databaseRole.

getDatabaseRoleBytes()

public ByteString getDatabaseRoleBytes()

Optional. Cloud Spanner database role for fine-grained access control. A database role is a collection of fine-grained access privileges. Example: Admin predefines roles that provides user a set of permissions (SELECT, INSERT, ..). The user can then specify a predefined role on a connection to execute their Cloud Spanner query. The role is passthrough here. If the user is not authorized to use the specified role, they get an error. This validation happens on Cloud Spanner. See https://cloud.google.com/spanner/docs/fgac-about for more details. REQUIRES: database role name must start with uppercase/lowercase letter and only contain uppercase/lowercase letters, numbers, and underscores.

string database_role = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for databaseRole.

getDefaultInstanceForType()

public CloudSpannerProperties getDefaultInstanceForType()
Returns
Type Description
CloudSpannerProperties

getParserForType()

public Parser<CloudSpannerProperties> getParserForType()
Returns
Type Description
Parser<CloudSpannerProperties>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUseParallelism()

public boolean getUseParallelism()

If parallelism should be used when reading from Cloud Spanner

bool use_parallelism = 2;

Returns
Type Description
boolean

The useParallelism.

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;

Returns
Type Description
boolean

The useServerlessAnalytics.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CloudSpannerProperties.Builder newBuilderForType()
Returns
Type Description
CloudSpannerProperties.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CloudSpannerProperties.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CloudSpannerProperties.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CloudSpannerProperties.Builder toBuilder()
Returns
Type Description
CloudSpannerProperties.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException