Class KeyRecipe.Part (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 static final class KeyRecipe.Part extends GeneratedMessage implements KeyRecipe.PartOrBuilder

An ssformat key is composed of a sequence of tag numbers and key column values. Part represents a single tag or key column value.

Protobuf type google.spanner.v1.KeyRecipe.Part

Inheritance

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

Implements

KeyRecipe.PartOrBuilder

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

IDENTIFIER_FIELD_NUMBER

public static final int IDENTIFIER_FIELD_NUMBER

Field Value
Type	Description
int

NULL_ORDER_FIELD_NUMBER

public static final int NULL_ORDER_FIELD_NUMBER

Field Value
Type	Description
int

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER

Field Value
Type	Description
int

RANDOM_FIELD_NUMBER

public static final int RANDOM_FIELD_NUMBER

Field Value
Type	Description
int

STRUCT_IDENTIFIERS_FIELD_NUMBER

public static final int STRUCT_IDENTIFIERS_FIELD_NUMBER

Field Value
Type	Description
int

TAG_FIELD_NUMBER

public static final int TAG_FIELD_NUMBER

Field Value
Type	Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

Field Value
Type	Description
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static KeyRecipe.Part getDefaultInstance()

Returns
Type	Description
KeyRecipe.Part

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static KeyRecipe.Part.Builder newBuilder()

Returns
Type	Description
KeyRecipe.Part.Builder

newBuilder(KeyRecipe.Part prototype)

public static KeyRecipe.Part.Builder newBuilder(KeyRecipe.Part prototype)

Parameter
Name	Description
prototype	KeyRecipe.Part

Returns
Type	Description
KeyRecipe.Part.Builder

parseDelimitedFrom(InputStream input)

public static KeyRecipe.Part parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe.Part parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static KeyRecipe.Part parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KeyRecipe.Part parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe.Part parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KeyRecipe.Part parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe.Part parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static KeyRecipe.Part parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe.Part parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static KeyRecipe.Part parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KeyRecipe.Part parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe.Part

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<KeyRecipe.Part> parser()

Returns
Type	Description
Parser<Part>

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.Part getDefaultInstanceForType()

Returns
Type	Description
KeyRecipe.Part

getIdentifier()

public String getIdentifier()

identifier is the name of the column or query parameter.

string identifier = 5;

Returns
Type	Description
String	The identifier.

getIdentifierBytes()

public ByteString getIdentifierBytes()

identifier is the name of the column or query parameter.

string identifier = 5;

Returns
Type	Description
ByteString	The bytes for identifier.

getNullOrder()

public KeyRecipe.Part.NullOrder getNullOrder()

How NULLs are represented in the encoded key part. Only present if tag is zero.

.google.spanner.v1.KeyRecipe.Part.NullOrder null_order = 3;

Returns
Type	Description
KeyRecipe.Part.NullOrder	The nullOrder.

getNullOrderValue()

public int getNullOrderValue()

How NULLs are represented in the encoded key part. Only present if tag is zero.

.google.spanner.v1.KeyRecipe.Part.NullOrder null_order = 3;

Returns
Type	Description
int	The enum numeric value on the wire for nullOrder.

getOrder()

public KeyRecipe.Part.Order getOrder()

Whether the key column is sorted ascending or descending. Only present if tag is zero.

.google.spanner.v1.KeyRecipe.Part.Order order = 2;

Returns
Type	Description
KeyRecipe.Part.Order	The order.

getOrderValue()

public int getOrderValue()

Whether the key column is sorted ascending or descending. Only present if tag is zero.

.google.spanner.v1.KeyRecipe.Part.Order order = 2;

Returns
Type	Description
int	The enum numeric value on the wire for order.

getParserForType()

public Parser<KeyRecipe.Part> getParserForType()

Returns
Type	Description
Parser<Part>

Overrides

GeneratedMessage.getParserForType()

getRandom()

public boolean getRandom()

If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type.

bool random = 8;

Returns
Type	Description
boolean	The random.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getStructIdentifiers(int index)

public int getStructIdentifiers(int index)

It is a repeated field to support fetching key columns from nested structs, such as STRUCT query parameters.

repeated int32 struct_identifiers = 7;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
int	The structIdentifiers at the given index.

getStructIdentifiersCount()

public int getStructIdentifiersCount()

It is a repeated field to support fetching key columns from nested structs, such as STRUCT query parameters.

repeated int32 struct_identifiers = 7;

Returns
Type	Description
int	The count of structIdentifiers.

getStructIdentifiersList()

public List<Integer> getStructIdentifiersList()

It is a repeated field to support fetching key columns from nested structs, such as STRUCT query parameters.

repeated int32 struct_identifiers = 7;

Returns
Type	Description
List<Integer>	A list containing the structIdentifiers.

getTag()

public int getTag()

If non-zero, tag is the only field present in this Part. The part is encoded by appending tag to the ssformat key.

uint32 tag = 1;

Returns
Type	Description
int	The tag.

getType()

public Type getType()

The type of the key part. Only present if tag is zero.

.google.spanner.v1.Type type = 4;

Returns
Type	Description
Type	The type.

getTypeOrBuilder()

public TypeOrBuilder getTypeOrBuilder()

The type of the key part. Only present if tag is zero.

.google.spanner.v1.Type type = 4;

Returns
Type	Description
TypeOrBuilder

getValue()

public Value getValue()

The constant value of the key part. It is present when query uses a constant as a part of the key.

.google.protobuf.Value value = 6;

Returns
Type	Description
Value	The value.

getValueOrBuilder()

public ValueOrBuilder getValueOrBuilder()

The constant value of the key part. It is present when query uses a constant as a part of the key.

.google.protobuf.Value value = 6;

Returns
Type	Description
ValueOrBuilder

getValueTypeCase()

public KeyRecipe.Part.ValueTypeCase getValueTypeCase()

Returns
Type	Description
KeyRecipe.Part.ValueTypeCase

hasIdentifier()

public boolean hasIdentifier()

identifier is the name of the column or query parameter.

string identifier = 5;

Returns
Type	Description
boolean	Whether the identifier field is set.

hasRandom()

public boolean hasRandom()

If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type.

bool random = 8;

Returns
Type	Description
boolean	Whether the random field is set.

hasType()

public boolean hasType()

The type of the key part. Only present if tag is zero.

.google.spanner.v1.Type type = 4;

Returns
Type	Description
boolean	Whether the type field is set.

hasValue()

public boolean hasValue()

The constant value of the key part. It is present when query uses a constant as a part of the key.

.google.protobuf.Value value = 6;

Returns
Type	Description
boolean	Whether the value 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.Part.Builder newBuilderForType()

Returns
Type	Description
KeyRecipe.Part.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected KeyRecipe.Part.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
KeyRecipe.Part.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public KeyRecipe.Part.Builder toBuilder()

Returns
Type	Description
KeyRecipe.Part.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException