Class: Google::Apis::SpannerV1::KeySet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/spanner_v1/classes.rb,
lib/google/apis/spanner_v1/representations.rb,
lib/google/apis/spanner_v1/representations.rb

Overview

KeySet defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way. If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ KeySet

Returns a new instance of KeySet.



1934
1935
1936
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1934

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#all ⇒ Boolean Also known as: all?

For convenience all can be set to true to indicate that this KeySet matches all keys in the table or index. Note that any keys specified in keys or ranges are only yielded once. Corresponds to the JSON property all

Returns:

  • (Boolean) 


1918
1919
1920
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1918

def all
  @all
end

#keys ⇒ Array<Array<Object>>

A list of specific keys. Entries in keys should have exactly as many elements as there are columns in the primary or index key with which this KeySet is used. Individual key values are encoded as described here. Corresponds to the JSON property keys

Returns:

  • (Array<Array<Object>>) 


1926
1927
1928
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1926

def keys
  @keys
end

#ranges ⇒ Array<Google::Apis::SpannerV1::KeyRange>

A list of key ranges. See KeyRange for more information about key range specifications. Corresponds to the JSON property ranges

Returns:



1932
1933
1934
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1932

def ranges
  @ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1939
1940
1941
1942
1943
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1939

def update!(**args)
  @all = args[:all] if args.key?(:all)
  @keys = args[:keys] if args.key?(:keys)
  @ranges = args[:ranges] if args.key?(:ranges)
end