Class KeyRecipe.Part (6.107.0)
Version latestkeyboard_arrow_down
public static final class KeyRecipe . Part extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static KeyRecipe . Part . Builder newBuilder ()
newBuilder(KeyRecipe.Part prototype)
public static KeyRecipe . Part . Builder newBuilder ( KeyRecipe . Part prototype )
public static KeyRecipe . Part parseDelimitedFrom ( InputStream input )
public static KeyRecipe . Part parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static KeyRecipe . Part parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static KeyRecipe . Part parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static KeyRecipe . Part parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static KeyRecipe . Part parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static KeyRecipe . Part parseFrom ( CodedInputStream input )
public static KeyRecipe . Part parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static KeyRecipe . Part parseFrom ( InputStream input )
public static KeyRecipe . Part parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static KeyRecipe . Part parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static KeyRecipe . Part parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<KeyRecipe . Part > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public KeyRecipe . Part getDefaultInstanceForType ()
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;
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;
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 ()
Overrides
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
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
indexint 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()
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()
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;
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;
getValueTypeCase()
public KeyRecipe . Part . ValueTypeCase getValueTypeCase ()
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()
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public KeyRecipe . Part . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected KeyRecipe . Part . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public KeyRecipe . Part . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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 2026-01-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-01-21 UTC."],[],[]]
