Interface KeyRecipe.PartOrBuilder (6.107.0)

public static interface KeyRecipe.PartOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIdentifier()

public abstract String getIdentifier()

identifier is the name of the column or query parameter.

string identifier = 5;

Returns
Type Description
String

The identifier.

getIdentifierBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getRandom()

public abstract 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.

getStructIdentifiers(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract KeyRecipe.Part.ValueTypeCase getValueTypeCase()
Returns
Type Description
KeyRecipe.Part.ValueTypeCase

hasIdentifier()

public abstract 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 abstract 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 abstract 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 abstract 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.