Class CloudSpannerProperties.Builder (2.16.0)

public static final class CloudSpannerProperties.Builder extends GeneratedMessageV3.Builder<CloudSpannerProperties.Builder> implements CloudSpannerPropertiesOrBuilder

Connection properties specific to Cloud Spanner.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CloudSpannerProperties.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

build()

public CloudSpannerProperties build()
Returns
TypeDescription
CloudSpannerProperties

buildPartial()

public CloudSpannerProperties buildPartial()
Returns
TypeDescription
CloudSpannerProperties

clear()

public CloudSpannerProperties.Builder clear()
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

clearDatabase()

public CloudSpannerProperties.Builder clearDatabase()

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

string database = 1;

Returns
TypeDescription
CloudSpannerProperties.Builder

This builder for chaining.

clearDatabaseRole()

public CloudSpannerProperties.Builder clearDatabaseRole()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CloudSpannerProperties.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CloudSpannerProperties.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

clearUseParallelism()

public CloudSpannerProperties.Builder clearUseParallelism()

If parallelism should be used when reading from Cloud Spanner

bool use_parallelism = 2;

Returns
TypeDescription
CloudSpannerProperties.Builder

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

This builder for chaining.

clone()

public CloudSpannerProperties.Builder clone()
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

getDatabase()

public String getDatabase()

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

string database = 1;

Returns
TypeDescription
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

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

string database = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for databaseRole.

getDefaultInstanceForType()

public CloudSpannerProperties getDefaultInstanceForType()
Returns
TypeDescription
CloudSpannerProperties

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getUseParallelism()

public boolean getUseParallelism()

If parallelism should be used when reading from Cloud Spanner

bool use_parallelism = 2;

Returns
TypeDescription
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
TypeDescription
boolean

The useServerlessAnalytics.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CloudSpannerProperties other)

public CloudSpannerProperties.Builder mergeFrom(CloudSpannerProperties other)
Parameter
NameDescription
otherCloudSpannerProperties
Returns
TypeDescription
CloudSpannerProperties.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CloudSpannerProperties.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CloudSpannerProperties.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CloudSpannerProperties.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

setDatabase(String value)

public CloudSpannerProperties.Builder setDatabase(String value)

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

string database = 1;

Parameter
NameDescription
valueString

The database to set.

Returns
TypeDescription
CloudSpannerProperties.Builder

This builder for chaining.

setDatabaseBytes(ByteString value)

public CloudSpannerProperties.Builder setDatabaseBytes(ByteString value)

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

string database = 1;

Parameter
NameDescription
valueByteString

The bytes for database to set.

Returns
TypeDescription
CloudSpannerProperties.Builder

This builder for chaining.

setDatabaseRole(String value)

public CloudSpannerProperties.Builder setDatabaseRole(String value)

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];

Parameter
NameDescription
valueString

The databaseRole to set.

Returns
TypeDescription
CloudSpannerProperties.Builder

This builder for chaining.

setDatabaseRoleBytes(ByteString value)

public CloudSpannerProperties.Builder setDatabaseRoleBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for databaseRole to set.

Returns
TypeDescription
CloudSpannerProperties.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CloudSpannerProperties.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CloudSpannerProperties.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CloudSpannerProperties.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CloudSpannerProperties.Builder
Overrides

setUseParallelism(boolean value)

public CloudSpannerProperties.Builder setUseParallelism(boolean value)

If parallelism should be used when reading from Cloud Spanner

bool use_parallelism = 2;

Parameter
NameDescription
valueboolean

The useParallelism to set.

Returns
TypeDescription
CloudSpannerProperties.Builder

This builder for chaining.

setUseServerlessAnalytics(boolean value)

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;

Parameter
NameDescription
valueboolean

The useServerlessAnalytics to set.

Returns
TypeDescription
CloudSpannerProperties.Builder

This builder for chaining.