Class SpannerDatabaseReference (0.21.0)

0.21.0 (latest) 0.19.0 0.16.0 0.15.0 0.13.0 0.11.0 0.10.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.2.0 0.1.0

public final class SpannerDatabaseReference extends GeneratedMessage implements SpannerDatabaseReferenceOrBuilder

Message representing a reference to a single Spanner database.

Protobuf type google.cloud.geminidataanalytics.v1beta.SpannerDatabaseReference

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SpannerDatabaseReference

Implements

SpannerDatabaseReferenceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER

Field Value
Type	Description
int

DATABASE_TABLE_REFERENCES_FIELD_NUMBER

public static final int DATABASE_TABLE_REFERENCES_FIELD_NUMBER

Field Value
Type	Description
int

ENGINE_FIELD_NUMBER

public static final int ENGINE_FIELD_NUMBER

Field Value
Type	Description
int

INSTANCE_ID_FIELD_NUMBER

public static final int INSTANCE_ID_FIELD_NUMBER

Field Value
Type	Description
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER

Field Value
Type	Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

Field Value
Type	Description
int

REQUEST_TAG_FIELD_NUMBER

public static final int REQUEST_TAG_FIELD_NUMBER

Field Value
Type	Description
int

TABLE_IDS_FIELD_NUMBER

public static final int TABLE_IDS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SpannerDatabaseReference getDefaultInstance()

Returns
Type	Description
SpannerDatabaseReference

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SpannerDatabaseReference.Builder newBuilder()

Returns
Type	Description
SpannerDatabaseReference.Builder

newBuilder(SpannerDatabaseReference prototype)

public static SpannerDatabaseReference.Builder newBuilder(SpannerDatabaseReference prototype)

Parameter
Name	Description
prototype	SpannerDatabaseReference

Returns
Type	Description
SpannerDatabaseReference.Builder

parseDelimitedFrom(InputStream input)

public static SpannerDatabaseReference parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerDatabaseReference parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SpannerDatabaseReference parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpannerDatabaseReference parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpannerDatabaseReference parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpannerDatabaseReference parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpannerDatabaseReference parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerDatabaseReference parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SpannerDatabaseReference parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerDatabaseReference parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SpannerDatabaseReference parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpannerDatabaseReference parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SpannerDatabaseReference

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SpannerDatabaseReference> parser()

Returns
Type	Description
Parser<SpannerDatabaseReference>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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

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.

getParserForType()

public Parser<SpannerDatabaseReference> getParserForType()

Returns
Type	Description
Parser<SpannerDatabaseReference>

Overrides

GeneratedMessage.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SpannerDatabaseReference.Builder newBuilderForType()

Returns
Type	Description
SpannerDatabaseReference.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SpannerDatabaseReference.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SpannerDatabaseReference.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SpannerDatabaseReference.Builder toBuilder()

Returns
Type	Description
SpannerDatabaseReference.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException