Class CloudSpannerProperties.Builder (2.25.0)

Version 2.25.0

• 2.53.0 (latest)
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.6
• 2.4.0
• 2.2.4
• 2.1.11

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

Inheritance

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

Implements

CloudSpannerPropertiesOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CloudSpannerProperties.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CloudSpannerProperties build()

Returns
Type	Description
CloudSpannerProperties

buildPartial()

public CloudSpannerProperties buildPartial()

Returns
Type	Description
CloudSpannerProperties

clear()

public CloudSpannerProperties.Builder clear()

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDatabase()

public CloudSpannerProperties.Builder clearDatabase()

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

string database = 1;

Returns
Type	Description
CloudSpannerProperties.Builder	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.

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
Type	Description
CloudSpannerProperties.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CloudSpannerProperties.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
CloudSpannerProperties.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CloudSpannerProperties.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
CloudSpannerProperties.Builder	This builder for chaining.

clearUseParallelism()

public CloudSpannerProperties.Builder clearUseParallelism()

If parallelism should be used when reading from Cloud Spanner

bool use_parallelism = 2;

Returns
Type	Description
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
Type	Description
CloudSpannerProperties.Builder	This builder for chaining.

clone()

public CloudSpannerProperties.Builder clone()

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

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
Type	Description
String	The databaseRole.

getDatabaseRoleBytes()

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

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
Type	Description
ByteString	The bytes for databaseRole.

getDefaultInstanceForType()

public CloudSpannerProperties getDefaultInstanceForType()

Returns
Type	Description
CloudSpannerProperties

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

Returns
Type	Description
int	The maxParallelism.

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;

Returns
Type	Description
boolean	The useDataBoost.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CloudSpannerProperties other)

public CloudSpannerProperties.Builder mergeFrom(CloudSpannerProperties other)

Parameter
Name	Description
other	CloudSpannerProperties

Returns
Type	Description
CloudSpannerProperties.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CloudSpannerProperties.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CloudSpannerProperties.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CloudSpannerProperties.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDatabase(String value)

public CloudSpannerProperties.Builder setDatabase(String value)

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

string database = 1;

Parameter
Name	Description
value	String The database to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for database to set.

Returns
Type	Description
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. 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.

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

Parameter
Name	Description
value	String The databaseRole to set.

Returns
Type	Description
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. 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.

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

Parameter
Name	Description
value	ByteString The bytes for databaseRole to set.

Returns
Type	Description
CloudSpannerProperties.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CloudSpannerProperties.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMaxParallelism(int value)

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;

Parameter
Name	Description
value	int The maxParallelism to set.

Returns
Type	Description
CloudSpannerProperties.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final CloudSpannerProperties.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CloudSpannerProperties.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUseDataBoost(boolean value)

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;

Parameter
Name	Description
value	boolean The useDataBoost to set.

Returns
Type	Description
CloudSpannerProperties.Builder	This builder for chaining.

setUseParallelism(boolean value)

public CloudSpannerProperties.Builder setUseParallelism(boolean value)

If parallelism should be used when reading from Cloud Spanner

bool use_parallelism = 2;

Parameter
Name	Description
value	boolean The useParallelism to set.

Returns
Type	Description
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
Name	Description
value	boolean The useServerlessAnalytics to set.

Returns
Type	Description
CloudSpannerProperties.Builder	This builder for chaining.