Send feedback
Class CloudSpannerProperties (2.19.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.19.0keyboard_arrow_down
public final class CloudSpannerProperties extends GeneratedMessageV3 implements CloudSpannerPropertiesOrBuilder
Connection properties specific to Cloud Spanner.
Protobuf type google.cloud.bigquery.connection.v1.CloudSpannerProperties
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
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
databyte []
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
objObject
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.
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
Type Description
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
Type Description
ByteString The bytes for databaseRole.
getDefaultInstanceForType()
public CloudSpannerProperties getDefaultInstanceForType ()
getParserForType()
public Parser<CloudSpannerProperties> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
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 )
Returns
Type Description
Object
Overrides
toBuilder()
public CloudSpannerProperties . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-13 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-13 UTC."],[],[]]
