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

Constructor Details

#initialize(**args) ⇒ PartitionReadRequest

Returns a new instance of PartitionReadRequest.



2124
2125
2126
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2124

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>) 


2090
2091
2092
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2090

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) 


2097
2098
2099
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2097

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:



2106
2107
2108
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2106

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:



2111
2112
2113
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2111

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) 


2116
2117
2118
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2116

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:



2122
2123
2124
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2122

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2129
2130
2131
2132
2133
2134
2135
2136
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2129

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