Class: Google::Apis::SpannerV1::PartitionReadRequest

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

Overview

The request for PartitionRead

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PartitionReadRequest

Returns a new instance of PartitionReadRequest.



2076
2077
2078
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2076

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

Instance Attribute Details

#columns ⇒ Array<String>

The columns of table to be returned for each row matching this request. Corresponds to the JSON property columns

Returns:

  • (Array<String>) 


2038
2039
2040
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2038

def columns
  @columns
end

#index ⇒ String

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. Corresponds to the JSON property index

Returns:

  • (String) 


2045
2046
2047
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2045

def index
  @index
end

#key_set ⇒ Google::Apis::SpannerV1::KeySet

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. Corresponds to the JSON property keySet

Returns:



2055
2056
2057
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2055

def key_set
  @key_set
end

#partition_options ⇒ Google::Apis::SpannerV1::PartitionOptions

Options for a PartitionQueryRequest and PartitionReadRequest. Corresponds to the JSON property partitionOptions

Returns:



2061
2062
2063
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2061

def partition_options
  @partition_options
end

#table ⇒ String

Required. The name of the table in the database to be read. Corresponds to the JSON property table

Returns:

  • (String) 


2066
2067
2068
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2066

def table
  @table
end

#transaction ⇒ Google::Apis::SpannerV1::TransactionSelector

This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions. Corresponds to the JSON property transaction

Returns:



2074
2075
2076
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2074

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2081
2082
2083
2084
2085
2086
2087
2088
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2081

def update!(**args)
  @columns = args[:columns] if args.key?(:columns)
  @index = args[:index] if args.key?(:index)
  @key_set = args[:key_set] if args.key?(:key_set)
  @partition_options = args[:partition_options] if args.key?(:partition_options)
  @table = args[:table] if args.key?(:table)
  @transaction = args[:transaction] if args.key?(:transaction)
end