Class SpannerDatabaseReference.Builder (0.21.0)

public static final class SpannerDatabaseReference.Builder extends GeneratedMessage.Builder<SpannerDatabaseReference.Builder> implements SpannerDatabaseReferenceOrBuilder

Message representing a reference to a single Spanner database.

Protobuf type google.cloud.geminidataanalytics.v1beta.SpannerDatabaseReference

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDatabaseTableReferences(Iterable<? extends DatabaseTableReference> values)

public SpannerDatabaseReference.Builder addAllDatabaseTableReferences(Iterable<? extends DatabaseTableReference> values)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.geminidataanalytics.v1beta.DatabaseTableReference>
Returns
Type Description
SpannerDatabaseReference.Builder

addAllTableIds(Iterable<String> values)

public SpannerDatabaseReference.Builder addAllTableIds(Iterable<String> values)

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The tableIds to add.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

addDatabaseTableReferences(DatabaseTableReference value)

public SpannerDatabaseReference.Builder addDatabaseTableReferences(DatabaseTableReference value)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DatabaseTableReference
Returns
Type Description
SpannerDatabaseReference.Builder

addDatabaseTableReferences(DatabaseTableReference.Builder builderForValue)

public SpannerDatabaseReference.Builder addDatabaseTableReferences(DatabaseTableReference.Builder builderForValue)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DatabaseTableReference.Builder
Returns
Type Description
SpannerDatabaseReference.Builder

addDatabaseTableReferences(int index, DatabaseTableReference value)

public SpannerDatabaseReference.Builder addDatabaseTableReferences(int index, DatabaseTableReference value)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value DatabaseTableReference
Returns
Type Description
SpannerDatabaseReference.Builder

addDatabaseTableReferences(int index, DatabaseTableReference.Builder builderForValue)

public SpannerDatabaseReference.Builder addDatabaseTableReferences(int index, DatabaseTableReference.Builder builderForValue)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue DatabaseTableReference.Builder
Returns
Type Description
SpannerDatabaseReference.Builder

addDatabaseTableReferencesBuilder()

public DatabaseTableReference.Builder addDatabaseTableReferencesBuilder()

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DatabaseTableReference.Builder

addDatabaseTableReferencesBuilder(int index)

public DatabaseTableReference.Builder addDatabaseTableReferencesBuilder(int index)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DatabaseTableReference.Builder

addTableIds(String value)

public SpannerDatabaseReference.Builder addTableIds(String value)

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The tableIds to add.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

addTableIdsBytes(ByteString value)

public SpannerDatabaseReference.Builder addTableIdsBytes(ByteString value)

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the tableIds to add.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

build()

public SpannerDatabaseReference build()
Returns
Type Description
SpannerDatabaseReference

buildPartial()

public SpannerDatabaseReference buildPartial()
Returns
Type Description
SpannerDatabaseReference

clear()

public SpannerDatabaseReference.Builder clear()
Returns
Type Description
SpannerDatabaseReference.Builder
Overrides

clearDatabaseId()

public SpannerDatabaseReference.Builder clearDatabaseId()

Required. The database id.

string database_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

clearDatabaseTableReferences()

public SpannerDatabaseReference.Builder clearDatabaseTableReferences()

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpannerDatabaseReference.Builder

clearEngine()

public SpannerDatabaseReference.Builder clearEngine()

Required. The engine of the Spanner instance.

.google.cloud.geminidataanalytics.v1beta.SpannerDatabaseReference.Engine engine = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

clearInstanceId()

public SpannerDatabaseReference.Builder clearInstanceId()

Required. The instance id.

string instance_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

clearPriority()

public SpannerDatabaseReference.Builder clearPriority()

Optional. Priority for the queries to Spanner. Should be a value supported by Cloud Spanner e.g.: LOW, MEDIUM, HIGH. Unsupported values will be ignored. See https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority for complete list.

string priority = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

clearProjectId()

public SpannerDatabaseReference.Builder clearProjectId()

Required. The project the instance belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

clearRequestTag()

public SpannerDatabaseReference.Builder clearRequestTag()

Tag to be attached to all queries to Spanner. Allows to identify and monitor queries sent to Spanner by the GDA service.

string request_tag = 9;

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

clearTableIds()

public SpannerDatabaseReference.Builder clearTableIds()

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

getDatabaseId()

public String getDatabaseId()

Required. The database id.

string database_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

Required. The database id.

string database_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for databaseId.

getDatabaseTableReferences(int index)

public DatabaseTableReference getDatabaseTableReferences(int index)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DatabaseTableReference

getDatabaseTableReferencesBuilder(int index)

public DatabaseTableReference.Builder getDatabaseTableReferencesBuilder(int index)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DatabaseTableReference.Builder

getDatabaseTableReferencesBuilderList()

public List<DatabaseTableReference.Builder> getDatabaseTableReferencesBuilderList()

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getDatabaseTableReferencesCount()

public int getDatabaseTableReferencesCount()

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDatabaseTableReferencesList()

public List<DatabaseTableReference> getDatabaseTableReferencesList()

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<DatabaseTableReference>

getDatabaseTableReferencesOrBuilder(int index)

public DatabaseTableReferenceOrBuilder getDatabaseTableReferencesOrBuilder(int index)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DatabaseTableReferenceOrBuilder

getDatabaseTableReferencesOrBuilderList()

public List<? extends DatabaseTableReferenceOrBuilder> getDatabaseTableReferencesOrBuilderList()

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1beta.DatabaseTableReferenceOrBuilder>

getDefaultInstanceForType()

public SpannerDatabaseReference getDefaultInstanceForType()
Returns
Type Description
SpannerDatabaseReference

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEngine()

public SpannerDatabaseReference.Engine getEngine()

Required. The engine of the Spanner instance.

.google.cloud.geminidataanalytics.v1beta.SpannerDatabaseReference.Engine engine = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SpannerDatabaseReference.Engine

The engine.

getEngineValue()

public int getEngineValue()

Required. The engine of the Spanner instance.

.google.cloud.geminidataanalytics.v1beta.SpannerDatabaseReference.Engine engine = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for engine.

getInstanceId()

public String getInstanceId()

Required. The instance id.

string instance_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The instanceId.

getInstanceIdBytes()

public ByteString getInstanceIdBytes()

Required. The instance id.

string instance_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for instanceId.

getPriority()

public String getPriority()

Optional. Priority for the queries to Spanner. Should be a value supported by Cloud Spanner e.g.: LOW, MEDIUM, HIGH. Unsupported values will be ignored. See https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority for complete list.

string priority = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The priority.

getPriorityBytes()

public ByteString getPriorityBytes()

Optional. Priority for the queries to Spanner. Should be a value supported by Cloud Spanner e.g.: LOW, MEDIUM, HIGH. Unsupported values will be ignored. See https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority for complete list.

string priority = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for priority.

getProjectId()

public String getProjectId()

Required. The project the instance belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. The project the instance belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

getRequestTag()

public String getRequestTag()

Tag to be attached to all queries to Spanner. Allows to identify and monitor queries sent to Spanner by the GDA service.

string request_tag = 9;

Returns
Type Description
String

The requestTag.

getRequestTagBytes()

public ByteString getRequestTagBytes()

Tag to be attached to all queries to Spanner. Allows to identify and monitor queries sent to Spanner by the GDA service.

string request_tag = 9;

Returns
Type Description
ByteString

The bytes for requestTag.

getTableIds(int index)

public String getTableIds(int index)

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tableIds at the given index.

getTableIdsBytes(int index)

public ByteString getTableIdsBytes(int index)

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tableIds at the given index.

getTableIdsCount()

public int getTableIdsCount()

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of tableIds.

getTableIdsList()

public ProtocolStringList getTableIdsList()

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the tableIds.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SpannerDatabaseReference other)

public SpannerDatabaseReference.Builder mergeFrom(SpannerDatabaseReference other)
Parameter
Name Description
other SpannerDatabaseReference
Returns
Type Description
SpannerDatabaseReference.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SpannerDatabaseReference.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerDatabaseReference.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SpannerDatabaseReference.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SpannerDatabaseReference.Builder
Overrides

removeDatabaseTableReferences(int index)

public SpannerDatabaseReference.Builder removeDatabaseTableReferences(int index)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SpannerDatabaseReference.Builder

setDatabaseId(String value)

public SpannerDatabaseReference.Builder setDatabaseId(String value)

Required. The database id.

string database_id = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The databaseId to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setDatabaseIdBytes(ByteString value)

public SpannerDatabaseReference.Builder setDatabaseIdBytes(ByteString value)

Required. The database id.

string database_id = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for databaseId to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setDatabaseTableReferences(int index, DatabaseTableReference value)

public SpannerDatabaseReference.Builder setDatabaseTableReferences(int index, DatabaseTableReference value)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value DatabaseTableReference
Returns
Type Description
SpannerDatabaseReference.Builder

setDatabaseTableReferences(int index, DatabaseTableReference.Builder builderForValue)

public SpannerDatabaseReference.Builder setDatabaseTableReferences(int index, DatabaseTableReference.Builder builderForValue)

Optional. References to tables within the database. Each reference specifies a table and can optionally include the table's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue DatabaseTableReference.Builder
Returns
Type Description
SpannerDatabaseReference.Builder

setEngine(SpannerDatabaseReference.Engine value)

public SpannerDatabaseReference.Builder setEngine(SpannerDatabaseReference.Engine value)

Required. The engine of the Spanner instance.

.google.cloud.geminidataanalytics.v1beta.SpannerDatabaseReference.Engine engine = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value SpannerDatabaseReference.Engine

The engine to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setEngineValue(int value)

public SpannerDatabaseReference.Builder setEngineValue(int value)

Required. The engine of the Spanner instance.

.google.cloud.geminidataanalytics.v1beta.SpannerDatabaseReference.Engine engine = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for engine to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setInstanceId(String value)

public SpannerDatabaseReference.Builder setInstanceId(String value)

Required. The instance id.

string instance_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The instanceId to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setInstanceIdBytes(ByteString value)

public SpannerDatabaseReference.Builder setInstanceIdBytes(ByteString value)

Required. The instance id.

string instance_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for instanceId to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setPriority(String value)

public SpannerDatabaseReference.Builder setPriority(String value)

Optional. Priority for the queries to Spanner. Should be a value supported by Cloud Spanner e.g.: LOW, MEDIUM, HIGH. Unsupported values will be ignored. See https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority for complete list.

string priority = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The priority to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setPriorityBytes(ByteString value)

public SpannerDatabaseReference.Builder setPriorityBytes(ByteString value)

Optional. Priority for the queries to Spanner. Should be a value supported by Cloud Spanner e.g.: LOW, MEDIUM, HIGH. Unsupported values will be ignored. See https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority for complete list.

string priority = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for priority to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setProjectId(String value)

public SpannerDatabaseReference.Builder setProjectId(String value)

Required. The project the instance belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public SpannerDatabaseReference.Builder setProjectIdBytes(ByteString value)

Required. The project the instance belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setRequestTag(String value)

public SpannerDatabaseReference.Builder setRequestTag(String value)

Tag to be attached to all queries to Spanner. Allows to identify and monitor queries sent to Spanner by the GDA service.

string request_tag = 9;

Parameter
Name Description
value String

The requestTag to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setRequestTagBytes(ByteString value)

public SpannerDatabaseReference.Builder setRequestTagBytes(ByteString value)

Tag to be attached to all queries to Spanner. Allows to identify and monitor queries sent to Spanner by the GDA service.

string request_tag = 9;

Parameter
Name Description
value ByteString

The bytes for requestTag to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.

setTableIds(int index, String value)

public SpannerDatabaseReference.Builder setTableIds(int index, String value)

Optional. The table ids. Denotes all tables if unset.

repeated string table_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The tableIds to set.

Returns
Type Description
SpannerDatabaseReference.Builder

This builder for chaining.