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

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

The request for PartitionRead

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PartitionReadRequest

Returns a new instance of PartitionReadRequest.



3140
3141
3142
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 3140

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


3106
3107
3108
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 3106

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) 


3113
3114
3115
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 3113

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:



3122
3123
3124
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 3122

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:



3127
3128
3129
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 3127

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) 


3132
3133
3134
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 3132

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:



3138
3139
3140
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 3138

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3145
3146
3147
3148
3149
3150
3151
3152
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 3145

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