Package com.google.spanner.v1
Class KeyRecipe.Part.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
com.google.spanner.v1.KeyRecipe.Part.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,KeyRecipe.PartOrBuilder,Cloneable
- Enclosing class:
- KeyRecipe.Part
public static final class KeyRecipe.Part.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
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-
Method Summary
Modifier and TypeMethodDescriptionaddAllStructIdentifiers(Iterable<? extends Integer> values) It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addStructIdentifiers(int value) It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.build()clear()clearField(com.google.protobuf.Descriptors.FieldDescriptor field) `identifier` is the name of the column or query parameter.How NULLs are represented in the encoded key part.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Whether the key column is sorted ascending or descending.If true, the client is responsible to fill in the value randomly.It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.clearTag()If non-zero, `tag` is the only field present in this `Part`.The type of the key part.The constant value of the key part.clone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptor`identifier` is the name of the column or query parameter.com.google.protobuf.ByteString`identifier` is the name of the column or query parameter.How NULLs are represented in the encoded key part.intHow NULLs are represented in the encoded key part.getOrder()Whether the key column is sorted ascending or descending.intWhether the key column is sorted ascending or descending.booleanIf true, the client is responsible to fill in the value randomly.intgetStructIdentifiers(int index) It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.intIt is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.intgetTag()If non-zero, `tag` is the only field present in this `Part`.getType()The type of the key part.The type of the key part.The type of the key part.com.google.protobuf.ValuegetValue()The constant value of the key part.com.google.protobuf.Value.BuilderThe constant value of the key part.com.google.protobuf.ValueOrBuilderThe constant value of the key part.boolean`identifier` is the name of the column or query parameter.booleanIf true, the client is responsible to fill in the value randomly.booleanhasType()The type of the key part.booleanhasValue()The constant value of the key part.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeFrom(KeyRecipe.Part other) The type of the key part.final KeyRecipe.Part.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) mergeValue(com.google.protobuf.Value value) The constant value of the key part.setIdentifier(String value) `identifier` is the name of the column or query parameter.setIdentifierBytes(com.google.protobuf.ByteString value) `identifier` is the name of the column or query parameter.How NULLs are represented in the encoded key part.setNullOrderValue(int value) How NULLs are represented in the encoded key part.setOrder(KeyRecipe.Part.Order value) Whether the key column is sorted ascending or descending.setOrderValue(int value) Whether the key column is sorted ascending or descending.setRandom(boolean value) If true, the client is responsible to fill in the value randomly.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setStructIdentifiers(int index, int value) It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.setTag(int value) If non-zero, `tag` is the only field present in this `Part`.The type of the key part.setType(Type.Builder builderForValue) The type of the key part.final KeyRecipe.Part.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setValue(com.google.protobuf.Value value) The constant value of the key part.setValue(com.google.protobuf.Value.Builder builderForValue) The constant value of the key part.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
setField
public KeyRecipe.Part.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
setRepeatedField
public KeyRecipe.Part.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
addRepeatedField
public KeyRecipe.Part.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<KeyRecipe.Part.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
mergeFrom
public KeyRecipe.Part.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<KeyRecipe.Part.Builder>- Throws:
IOException
-
getValueTypeCase
- Specified by:
getValueTypeCasein interfaceKeyRecipe.PartOrBuilder
-
clearValueType
-
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;- Specified by:
getTagin interfaceKeyRecipe.PartOrBuilder- Returns:
- The tag.
-
setTag
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;- Parameters:
value- The tag to set.- Returns:
- This builder for chaining.
-
clearTag
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:
- This builder for chaining.
-
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;- Specified by:
getOrderValuein interfaceKeyRecipe.PartOrBuilder- Returns:
- The enum numeric value on the wire for order.
-
setOrderValue
Whether the key column is sorted ascending or descending. Only present if `tag` is zero.
.google.spanner.v1.KeyRecipe.Part.Order order = 2;- Parameters:
value- The enum numeric value on the wire for order to set.- Returns:
- This builder for chaining.
-
getOrder
Whether the key column is sorted ascending or descending. Only present if `tag` is zero.
.google.spanner.v1.KeyRecipe.Part.Order order = 2;- Specified by:
getOrderin interfaceKeyRecipe.PartOrBuilder- Returns:
- The order.
-
setOrder
Whether the key column is sorted ascending or descending. Only present if `tag` is zero.
.google.spanner.v1.KeyRecipe.Part.Order order = 2;- Parameters:
value- The order to set.- Returns:
- This builder for chaining.
-
clearOrder
Whether the key column is sorted ascending or descending. Only present if `tag` is zero.
.google.spanner.v1.KeyRecipe.Part.Order order = 2;- Returns:
- This builder for chaining.
-
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;- Specified by:
getNullOrderValuein interfaceKeyRecipe.PartOrBuilder- Returns:
- The enum numeric value on the wire for nullOrder.
-
setNullOrderValue
How NULLs are represented in the encoded key part. Only present if `tag` is zero.
.google.spanner.v1.KeyRecipe.Part.NullOrder null_order = 3;- Parameters:
value- The enum numeric value on the wire for nullOrder to set.- Returns:
- This builder for chaining.
-
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;- Specified by:
getNullOrderin interfaceKeyRecipe.PartOrBuilder- Returns:
- The nullOrder.
-
setNullOrder
How NULLs are represented in the encoded key part. Only present if `tag` is zero.
.google.spanner.v1.KeyRecipe.Part.NullOrder null_order = 3;- Parameters:
value- The nullOrder to set.- Returns:
- This builder for chaining.
-
clearNullOrder
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:
- This builder for chaining.
-
hasType
public boolean hasType()The type of the key part. Only present if `tag` is zero.
.google.spanner.v1.Type type = 4;- Specified by:
hasTypein interfaceKeyRecipe.PartOrBuilder- Returns:
- Whether the type field is set.
-
getType
The type of the key part. Only present if `tag` is zero.
.google.spanner.v1.Type type = 4;- Specified by:
getTypein interfaceKeyRecipe.PartOrBuilder- Returns:
- The type.
-
setType
The type of the key part. Only present if `tag` is zero.
.google.spanner.v1.Type type = 4; -
setType
The type of the key part. Only present if `tag` is zero.
.google.spanner.v1.Type type = 4; -
mergeType
The type of the key part. Only present if `tag` is zero.
.google.spanner.v1.Type type = 4; -
clearType
The type of the key part. Only present if `tag` is zero.
.google.spanner.v1.Type type = 4; -
getTypeBuilder
The type of the key part. Only present if `tag` is zero.
.google.spanner.v1.Type type = 4; -
getTypeOrBuilder
The type of the key part. Only present if `tag` is zero.
.google.spanner.v1.Type type = 4;- Specified by:
getTypeOrBuilderin interfaceKeyRecipe.PartOrBuilder
-
hasIdentifier
public boolean hasIdentifier()`identifier` is the name of the column or query parameter.
string identifier = 5;- Specified by:
hasIdentifierin interfaceKeyRecipe.PartOrBuilder- Returns:
- Whether the identifier field is set.
-
getIdentifier
`identifier` is the name of the column or query parameter.
string identifier = 5;- Specified by:
getIdentifierin interfaceKeyRecipe.PartOrBuilder- Returns:
- The identifier.
-
getIdentifierBytes
public com.google.protobuf.ByteString getIdentifierBytes()`identifier` is the name of the column or query parameter.
string identifier = 5;- Specified by:
getIdentifierBytesin interfaceKeyRecipe.PartOrBuilder- Returns:
- The bytes for identifier.
-
setIdentifier
`identifier` is the name of the column or query parameter.
string identifier = 5;- Parameters:
value- The identifier to set.- Returns:
- This builder for chaining.
-
clearIdentifier
`identifier` is the name of the column or query parameter.
string identifier = 5;- Returns:
- This builder for chaining.
-
setIdentifierBytes
`identifier` is the name of the column or query parameter.
string identifier = 5;- Parameters:
value- The bytes for identifier to set.- Returns:
- This builder for chaining.
-
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;- Specified by:
hasValuein interfaceKeyRecipe.PartOrBuilder- Returns:
- Whether the value field is set.
-
getValue
public com.google.protobuf.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;- Specified by:
getValuein interfaceKeyRecipe.PartOrBuilder- Returns:
- The value.
-
setValue
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; -
setValue
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; -
mergeValue
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; -
clearValue
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; -
getValueBuilder
public com.google.protobuf.Value.Builder getValueBuilder()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; -
getValueOrBuilder
public com.google.protobuf.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;- Specified by:
getValueOrBuilderin interfaceKeyRecipe.PartOrBuilder
-
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;- Specified by:
hasRandomin interfaceKeyRecipe.PartOrBuilder- Returns:
- Whether the random field is set.
-
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;- Specified by:
getRandomin interfaceKeyRecipe.PartOrBuilder- Returns:
- The random.
-
setRandom
If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type.
bool random = 8;- Parameters:
value- The random to set.- Returns:
- This builder for chaining.
-
clearRandom
If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type.
bool random = 8;- Returns:
- This builder for chaining.
-
getStructIdentifiersList
It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
repeated int32 struct_identifiers = 7;- Specified by:
getStructIdentifiersListin interfaceKeyRecipe.PartOrBuilder- Returns:
- A list containing the structIdentifiers.
-
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;- Specified by:
getStructIdentifiersCountin interfaceKeyRecipe.PartOrBuilder- Returns:
- The count of structIdentifiers.
-
getStructIdentifiers
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;- Specified by:
getStructIdentifiersin interfaceKeyRecipe.PartOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The structIdentifiers at the given index.
-
setStructIdentifiers
It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
repeated int32 struct_identifiers = 7;- Parameters:
index- The index to set the value at.value- The structIdentifiers to set.- Returns:
- This builder for chaining.
-
addStructIdentifiers
It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
repeated int32 struct_identifiers = 7;- Parameters:
value- The structIdentifiers to add.- Returns:
- This builder for chaining.
-
addAllStructIdentifiers
It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
repeated int32 struct_identifiers = 7;- Parameters:
values- The structIdentifiers to add.- Returns:
- This builder for chaining.
-
clearStructIdentifiers
It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
repeated int32 struct_identifiers = 7;- Returns:
- This builder for chaining.
-
setUnknownFields
public final KeyRecipe.Part.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-
mergeUnknownFields
public final KeyRecipe.Part.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRecipe.Part.Builder>
-