Interface CloudSpannerPropertiesOrBuilder (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 interface CloudSpannerPropertiesOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDatabase()

public abstract String getDatabase()

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

string database = 1;

Returns
Type	Description
String	The database.

getDatabaseBytes()

public abstract ByteString getDatabaseBytes()

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

string database = 1;

Returns
Type	Description
ByteString	The bytes for database.

getDatabaseRole()

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

getMaxParallelism()

public abstract 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 abstract 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 abstract boolean getUseParallelism()

If parallelism should be used when reading from Cloud Spanner

bool use_parallelism = 2;

Returns
Type	Description
boolean	The useParallelism.

getUseServerlessAnalytics()

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