Google Cloud Spanner v1 API - Class KeyRecipe (5.10.0) 

public sealed class KeyRecipe : IMessage<KeyRecipe>, IEquatable<KeyRecipe>, IDeepCloneable<KeyRecipe>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner v1 API class KeyRecipe.

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.

Inheritance

object > KeyRecipe

Namespace

Google.Cloud.Spanner.V1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

KeyRecipe()

public KeyRecipe()

KeyRecipe(KeyRecipe)

public KeyRecipe(KeyRecipe other)
Parameter
Name Description
other KeyRecipe

Properties

HasIndexName

public bool HasIndexName { get; }

Gets whether the "index_name" field is set

Property Value
Type Description
bool

HasOperationUid

public bool HasOperationUid { get; }

Gets whether the "operation_uid" field is set

Property Value
Type Description
bool

HasTableName

public bool HasTableName { get; }

Gets whether the "table_name" field is set

Property Value
Type Description
bool

IndexName

public string IndexName { get; set; }

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

Property Value
Type Description
string

OperationUid

public ulong OperationUid { get; set; }

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

Property Value
Type Description
ulong

Part

public RepeatedField<KeyRecipe.Types.Part> Part { get; }

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

Property Value
Type Description
RepeatedFieldKeyRecipeTypesPart

TableName

public string TableName { get; set; }

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

Property Value
Type Description
string

TargetCase

public KeyRecipe.TargetOneofCase TargetCase { get; }
Property Value
Type Description
KeyRecipeTargetOneofCase