Class KeyRecipe (6.108.0)

Version latest

• 6.108.0 (latest)
• 6.107.0
• 6.103.0
• 6.102.1
• 6.101.1
• 6.100.0
• 6.99.0
• 6.98.1
• 6.97.1
• 6.96.1
• 6.95.1
• 6.94.0
• 6.93.0
• 6.89.0
• 6.88.0
• 6.87.0
• 6.86.0
• 6.85.0
• 6.83.0
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public final class KeyRecipe extends GeneratedMessage implements KeyRecipeOrBuilder

A KeyRecipe provides the metadata required to translate reads, mutations, and queries into a byte array in "sortable string format" (ssformat)that can be used with Ranges to route requests. Note that the client must tolerate KeyRecipes that appear to be invalid, since the KeyRecipe format may change over time. Requests with invalid KeyRecipes should be routed to a default server.

Protobuf type google.spanner.v1.KeyRecipe

Inheritance

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

Implements

KeyRecipeOrBuilder

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

INDEX_NAME_FIELD_NUMBER

public static final int INDEX_NAME_FIELD_NUMBER

Field Value
Type	Description
int

OPERATION_UID_FIELD_NUMBER

public static final int OPERATION_UID_FIELD_NUMBER

Field Value
Type	Description
int

PART_FIELD_NUMBER

public static final int PART_FIELD_NUMBER

Field Value
Type	Description
int

TABLE_NAME_FIELD_NUMBER

public static final int TABLE_NAME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static KeyRecipe getDefaultInstance()

Returns
Type	Description
KeyRecipe

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static KeyRecipe.Builder newBuilder()

Returns
Type	Description
KeyRecipe.Builder

newBuilder(KeyRecipe prototype)

public static KeyRecipe.Builder newBuilder(KeyRecipe prototype)

Parameter
Name	Description
prototype	KeyRecipe

Returns
Type	Description
KeyRecipe.Builder

parseDelimitedFrom(InputStream input)

public static KeyRecipe parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static KeyRecipe parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KeyRecipe parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KeyRecipe parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static KeyRecipe parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static KeyRecipe parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<KeyRecipe> parser()

Returns
Type	Description
Parser<KeyRecipe>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public KeyRecipe getDefaultInstanceForType()

Returns
Type	Description
KeyRecipe

getIndexName()

public String getIndexName()

An index name, matching the name from the database schema.

string index_name = 2;

Returns
Type	Description
String	The indexName.

getIndexNameBytes()

public ByteString getIndexNameBytes()

An index name, matching the name from the database schema.

string index_name = 2;

Returns
Type	Description
ByteString	The bytes for indexName.

getOperationUid()

public long getOperationUid()

The UID of a query, matching the UID from RoutingHint.

uint64 operation_uid = 3;

Returns
Type	Description
long	The operationUid.

getParserForType()

public Parser<KeyRecipe> getParserForType()

Returns
Type	Description
Parser<KeyRecipe>

Overrides

GeneratedMessage.getParserForType()

getPart(int index)

public KeyRecipe.Part getPart(int index)

Parts are in the order they should appear in the encoded key.

repeated .google.spanner.v1.KeyRecipe.Part part = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyRecipe.Part

getPartCount()

public int getPartCount()

Parts are in the order they should appear in the encoded key.

repeated .google.spanner.v1.KeyRecipe.Part part = 4;

Returns
Type	Description
int

getPartList()

public List<KeyRecipe.Part> getPartList()

Parts are in the order they should appear in the encoded key.

repeated .google.spanner.v1.KeyRecipe.Part part = 4;

Returns
Type	Description
List<Part>

getPartOrBuilder(int index)

public KeyRecipe.PartOrBuilder getPartOrBuilder(int index)

Parts are in the order they should appear in the encoded key.

repeated .google.spanner.v1.KeyRecipe.Part part = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyRecipe.PartOrBuilder

getPartOrBuilderList()

public List<? extends KeyRecipe.PartOrBuilder> getPartOrBuilderList()

Parts are in the order they should appear in the encoded key.

repeated .google.spanner.v1.KeyRecipe.Part part = 4;

Returns
Type	Description
List<? extends com.google.spanner.v1.KeyRecipe.PartOrBuilder>

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getTableName()

public String getTableName()

A table name, matching the name from the database schema.

string table_name = 1;

Returns
Type	Description
String	The tableName.

getTableNameBytes()

public ByteString getTableNameBytes()

A table name, matching the name from the database schema.

string table_name = 1;

Returns
Type	Description
ByteString	The bytes for tableName.

getTargetCase()

public KeyRecipe.TargetCase getTargetCase()

Returns
Type	Description
KeyRecipe.TargetCase

hasIndexName()

public boolean hasIndexName()

An index name, matching the name from the database schema.

string index_name = 2;

Returns
Type	Description
boolean	Whether the indexName field is set.

hasOperationUid()

public boolean hasOperationUid()

The UID of a query, matching the UID from RoutingHint.

uint64 operation_uid = 3;

Returns
Type	Description
boolean	Whether the operationUid field is set.

hasTableName()

public boolean hasTableName()

A table name, matching the name from the database schema.

string table_name = 1;

Returns
Type	Description
boolean	Whether the tableName field is set.

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 KeyRecipe.Builder newBuilderForType()

Returns
Type	Description
KeyRecipe.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected KeyRecipe.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
KeyRecipe.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public KeyRecipe.Builder toBuilder()

Returns
Type	Description
KeyRecipe.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException