All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CloudSpannerProperties, CloudSpannerProperties.Builder
```
public interface CloudSpannerPropertiesOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDatabase()`	Cloud Spanner database in the form `project/instance/database'
`com.google.protobuf.ByteString`	`getDatabaseBytes()`	Cloud Spanner database in the form `project/instance/database'
`String`	`getDatabaseRole()`	Optional.
`com.google.protobuf.ByteString`	`getDatabaseRoleBytes()`	Optional.
`int`	`getMaxParallelism()`	Allows setting max parallelism per query when executing on Spanner independent compute resources.
`boolean`	`getUseDataBoost()`	If set, the request will be executed via Spanner independent compute resources.
`boolean`	`getUseParallelism()`	If parallelism should be used when reading from Cloud Spanner
`boolean`	`getUseServerlessAnalytics()`	If the serverless analytics service should be used to read data from Cloud Spanner.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getDatabase

String getDatabase()

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

string database = 1;

Returns:: The database.

getDatabaseBytes

com.google.protobuf.ByteString getDatabaseBytes()

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

string database = 1;

Returns:: The bytes for database.

getUseParallelism

boolean getUseParallelism()

 If parallelism should be used when reading from Cloud Spanner

bool use_parallelism = 2;

Returns:: The useParallelism.

getMaxParallelism

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:: The maxParallelism.

getUseServerlessAnalytics

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:: The useServerlessAnalytics.

getUseDataBoost

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:: The useDataBoost.

getDatabaseRole

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

Returns:: The databaseRole.

getDatabaseRoleBytes

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.