Class: Google::Apis::SpannerV1::ReadRequest

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 Read and StreamingRead.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReadRequest

Returns a new instance of ReadRequest.



5314
5315
5316
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5314

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

Instance Attribute Details

#columns ⇒ Array<String>

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

Returns:

  • (Array<String>) 


5221
5222
5223
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5221

def columns
  @columns
end

#data_boost_enabled ⇒ Boolean Also known as: data_boost_enabled?

If this is for a partitioned read and this field is set to true, the request is executed with Spanner Data Boost independent compute resources. If the field is set to true but the request does not set partition_token, the API returns an INVALID_ARGUMENT error. Corresponds to the JSON property dataBoostEnabled

Returns:

  • (Boolean) 


5229
5230
5231
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5229

def data_boost_enabled
  @data_boost_enabled
end

#directed_read_options ⇒ Google::Apis::SpannerV1::DirectedReadOptions

The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries. DirectedReadOptions may only be specified for a read-only transaction, otherwise the API will return an INVALID_ARGUMENT error. Corresponds to the JSON property directedReadOptions

Returns:



5238
5239
5240
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5238

def directed_read_options
  @directed_read_options
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) 


5245
5246
5247
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5245

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:



5254
5255
5256
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5254

def key_set
  @key_set
end

#limit ⇒ Fixnum

If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. A limit cannot be specified if partition_token is set. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


5261
5262
5263
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5261

def limit
  @limit
end

#lock_hint ⇒ String

Optional. Lock Hint for the request, it can only be used with read-write transactions. Corresponds to the JSON property lockHint

Returns:

  • (String) 


5267
5268
5269
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5267

def lock_hint
  @lock_hint
end

#order_by ⇒ String

Optional. Order for the returned rows. By default, Spanner will return result rows in primary key order except for PartitionRead requests. For applications that do not require rows to be returned in primary key (ORDER_BY_PRIMARY_KEY) order, setting ORDER_BY_NO_ORDER option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (e.g. bulk point lookups). Corresponds to the JSON property orderBy

Returns:

  • (String) 


5277
5278
5279
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5277

def order_by
  @order_by
end

#partition_token ⇒ String

If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. Corresponds to the JSON property partitionToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5286
5287
5288
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5286

def partition_token
  @partition_token
end

#request_options ⇒ Google::Apis::SpannerV1::RequestOptions

Common request options for various APIs. Corresponds to the JSON property requestOptions

Returns:



5291
5292
5293
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5291

def request_options
  @request_options
end

#resume_token ⇒ String

If this request is resuming a previously interrupted read, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. Corresponds to the JSON property resumeToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5301
5302
5303
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5301

def resume_token
  @resume_token
end

#table ⇒ String

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

Returns:

  • (String) 


5306
5307
5308
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5306

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:



5312
5313
5314
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5312

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 5319

def update!(**args)
  @columns = args[:columns] if args.key?(:columns)
  @data_boost_enabled = args[:data_boost_enabled] if args.key?(:data_boost_enabled)
  @directed_read_options = args[:directed_read_options] if args.key?(:directed_read_options)
  @index = args[:index] if args.key?(:index)
  @key_set = args[:key_set] if args.key?(:key_set)
  @limit = args[:limit] if args.key?(:limit)
  @lock_hint = args[:lock_hint] if args.key?(:lock_hint)
  @order_by = args[:order_by] if args.key?(:order_by)
  @partition_token = args[:partition_token] if args.key?(:partition_token)
  @request_options = args[:request_options] if args.key?(:request_options)
  @resume_token = args[:resume_token] if args.key?(:resume_token)
  @table = args[:table] if args.key?(:table)
  @transaction = args[:transaction] if args.key?(:transaction)
end