public final class CloudSpannerProperties extends GeneratedMessageV3 implements CloudSpannerPropertiesOrBuilder
Connection properties specific to Cloud Spanner.
Protobuf type google.cloud.bigquery.connection.v1.CloudSpannerProperties
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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 | |
MAX_PARALLELISM_FIELD_NUMBER
public static final int MAX_PARALLELISM_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USE_DATA_BOOST_FIELD_NUMBER
public static final int USE_DATA_BOOST_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CloudSpannerProperties.Builder newBuilder()
newBuilder(CloudSpannerProperties prototype)
public static CloudSpannerProperties.Builder newBuilder(CloudSpannerProperties prototype)
public static CloudSpannerProperties parseDelimitedFrom(InputStream input)
public static CloudSpannerProperties parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CloudSpannerProperties parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CloudSpannerProperties parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CloudSpannerProperties parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CloudSpannerProperties parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CloudSpannerProperties parseFrom(CodedInputStream input)
public static CloudSpannerProperties parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CloudSpannerProperties parseFrom(InputStream input)
public static CloudSpannerProperties parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CloudSpannerProperties parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CloudSpannerProperties parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CloudSpannerProperties> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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.
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()
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.
|
getParserForType()
public Parser<CloudSpannerProperties> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CloudSpannerProperties.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CloudSpannerProperties.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public CloudSpannerProperties.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
