Class KeyRecipe.Builder (6.107.0)

Version latest

• 6.107.0 (latest)
• 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.Builder extends GeneratedMessageV3.Builder<KeyRecipe.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > KeyRecipe.Builder

Implements

KeyRecipeOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllPart(Iterable<? extends KeyRecipe.Part> values)

public KeyRecipe.Builder addAllPart(Iterable<? extends KeyRecipe.Part> values)

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

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

Parameter
Name	Description
values	Iterable<? extends com.google.spanner.v1.KeyRecipe.Part>

Returns
Type	Description
KeyRecipe.Builder

addPart(KeyRecipe.Part value)

public KeyRecipe.Builder addPart(KeyRecipe.Part value)

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

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

Parameter
Name	Description
value	KeyRecipe.Part

Returns
Type	Description
KeyRecipe.Builder

addPart(KeyRecipe.Part.Builder builderForValue)

public KeyRecipe.Builder addPart(KeyRecipe.Part.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	KeyRecipe.Part.Builder

Returns
Type	Description
KeyRecipe.Builder

addPart(int index, KeyRecipe.Part value)

public KeyRecipe.Builder addPart(int index, KeyRecipe.Part value)

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

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

Parameters
Name	Description
index	int
value	KeyRecipe.Part

Returns
Type	Description
KeyRecipe.Builder

addPart(int index, KeyRecipe.Part.Builder builderForValue)

public KeyRecipe.Builder addPart(int index, KeyRecipe.Part.Builder builderForValue)

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

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

Parameters
Name	Description
index	int
builderForValue	KeyRecipe.Part.Builder

Returns
Type	Description
KeyRecipe.Builder

addPartBuilder()

public KeyRecipe.Part.Builder addPartBuilder()

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

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

Returns
Type	Description
KeyRecipe.Part.Builder

addPartBuilder(int index)

public KeyRecipe.Part.Builder addPartBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KeyRecipe.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public KeyRecipe build()

Returns
Type	Description
KeyRecipe

buildPartial()

public KeyRecipe buildPartial()

Returns
Type	Description
KeyRecipe

clear()

public KeyRecipe.Builder clear()

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public KeyRecipe.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIndexName()

public KeyRecipe.Builder clearIndexName()

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

string index_name = 2;

Returns
Type	Description
KeyRecipe.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public KeyRecipe.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOperationUid()

public KeyRecipe.Builder clearOperationUid()

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

uint64 operation_uid = 3;

Returns
Type	Description
KeyRecipe.Builder	This builder for chaining.

clearPart()

public KeyRecipe.Builder clearPart()

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

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

Returns
Type	Description
KeyRecipe.Builder

clearTableName()

public KeyRecipe.Builder clearTableName()

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

string table_name = 1;

Returns
Type	Description
KeyRecipe.Builder	This builder for chaining.

clearTarget()

public KeyRecipe.Builder clearTarget()

Returns
Type	Description
KeyRecipe.Builder

clone()

public KeyRecipe.Builder clone()

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public KeyRecipe getDefaultInstanceForType()

Returns
Type	Description
KeyRecipe

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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

getPartBuilder(int index)

public KeyRecipe.Part.Builder getPartBuilder(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.Builder

getPartBuilderList()

public List<KeyRecipe.Part.Builder> getPartBuilderList()

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

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

Returns
Type	Description
List<Builder>

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>

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public KeyRecipe.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeyRecipe.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public KeyRecipe.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
KeyRecipe.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(KeyRecipe other)

public KeyRecipe.Builder mergeFrom(KeyRecipe other)

Parameter
Name	Description
other	KeyRecipe

Returns
Type	Description
KeyRecipe.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KeyRecipe.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removePart(int index)

public KeyRecipe.Builder removePart(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.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public KeyRecipe.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIndexName(String value)

public KeyRecipe.Builder setIndexName(String value)

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

string index_name = 2;

Parameter
Name	Description
value	String The indexName to set.

Returns
Type	Description
KeyRecipe.Builder	This builder for chaining.

setIndexNameBytes(ByteString value)

public KeyRecipe.Builder setIndexNameBytes(ByteString value)

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

string index_name = 2;

Parameter
Name	Description
value	ByteString The bytes for indexName to set.

Returns
Type	Description
KeyRecipe.Builder	This builder for chaining.

setOperationUid(long value)

public KeyRecipe.Builder setOperationUid(long value)

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

uint64 operation_uid = 3;

Parameter
Name	Description
value	long The operationUid to set.

Returns
Type	Description
KeyRecipe.Builder	This builder for chaining.

setPart(int index, KeyRecipe.Part value)

public KeyRecipe.Builder setPart(int index, KeyRecipe.Part value)

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

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

Parameters
Name	Description
index	int
value	KeyRecipe.Part

Returns
Type	Description
KeyRecipe.Builder

setPart(int index, KeyRecipe.Part.Builder builderForValue)

public KeyRecipe.Builder setPart(int index, KeyRecipe.Part.Builder builderForValue)

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

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

Parameters
Name	Description
index	int
builderForValue	KeyRecipe.Part.Builder

Returns
Type	Description
KeyRecipe.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public KeyRecipe.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTableName(String value)

public KeyRecipe.Builder setTableName(String value)

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

string table_name = 1;

Parameter
Name	Description
value	String The tableName to set.

Returns
Type	Description
KeyRecipe.Builder	This builder for chaining.

setTableNameBytes(ByteString value)

public KeyRecipe.Builder setTableNameBytes(ByteString value)

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

string table_name = 1;

Parameter
Name	Description
value	ByteString The bytes for tableName to set.

Returns
Type	Description
KeyRecipe.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final KeyRecipe.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
KeyRecipe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)