Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::KeyRecipe::Part (v1.12.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::KeyRecipe::Part.

An ssformat key is composed of a sequence of tag numbers and key column values. Part represents a single tag or key column value.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#identifier

def identifier() -> ::String
Returns
  • (::String) — identifier is the name of the column or query parameter.

    Note: The following fields are mutually exclusive: identifier, value, random. If a field in that set is populated, all other fields in the set will automatically be cleared.

#identifier=

def identifier=(value) -> ::String
Parameter
  • value (::String) — identifier is the name of the column or query parameter.

    Note: The following fields are mutually exclusive: identifier, value, random. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — identifier is the name of the column or query parameter.

    Note: The following fields are mutually exclusive: identifier, value, random. If a field in that set is populated, all other fields in the set will automatically be cleared.

#null_order

def null_order() -> ::Google::Cloud::Spanner::V1::KeyRecipe::Part::NullOrder
Returns

#null_order=

def null_order=(value) -> ::Google::Cloud::Spanner::V1::KeyRecipe::Part::NullOrder
Parameter
Returns

#order

def order() -> ::Google::Cloud::Spanner::V1::KeyRecipe::Part::Order
Returns

#order=

def order=(value) -> ::Google::Cloud::Spanner::V1::KeyRecipe::Part::Order
Parameter
Returns

#random

def random() -> ::Boolean
Returns
  • (::Boolean) — If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type.

    Note: The following fields are mutually exclusive: random, identifier, value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#random=

def random=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type.

    Note: The following fields are mutually exclusive: random, identifier, value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Boolean) — If true, the client is responsible to fill in the value randomly. It's relevant only for the INT64 type.

    Note: The following fields are mutually exclusive: random, identifier, value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#struct_identifiers

def struct_identifiers() -> ::Array<::Integer>
Returns
  • (::Array<::Integer>) — It is a repeated field to support fetching key columns from nested structs, such as STRUCT query parameters.

#struct_identifiers=

def struct_identifiers=(value) -> ::Array<::Integer>
Parameter
  • value (::Array<::Integer>) — It is a repeated field to support fetching key columns from nested structs, such as STRUCT query parameters.
Returns
  • (::Array<::Integer>) — It is a repeated field to support fetching key columns from nested structs, such as STRUCT query parameters.

#tag

def tag() -> ::Integer
Returns
  • (::Integer) — If non-zero, tag is the only field present in this Part. The part is encoded by appending tag to the ssformat key.

#tag=

def tag=(value) -> ::Integer
Parameter
  • value (::Integer) — If non-zero, tag is the only field present in this Part. The part is encoded by appending tag to the ssformat key.
Returns
  • (::Integer) — If non-zero, tag is the only field present in this Part. The part is encoded by appending tag to the ssformat key.

#type

def type() -> ::Google::Cloud::Spanner::V1::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Spanner::V1::Type
Parameter
Returns

#value

def value() -> ::Google::Protobuf::Value
Returns
  • (::Google::Protobuf::Value) — The constant value of the key part. It is present when query uses a constant as a part of the key.

    Note: The following fields are mutually exclusive: value, identifier, random. If a field in that set is populated, all other fields in the set will automatically be cleared.

#value=

def value=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::Google::Protobuf::Value) — The constant value of the key part. It is present when query uses a constant as a part of the key.

    Note: The following fields are mutually exclusive: value, identifier, random. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Value) — The constant value of the key part. It is present when query uses a constant as a part of the key.

    Note: The following fields are mutually exclusive: value, identifier, random. If a field in that set is populated, all other fields in the set will automatically be cleared.