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

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

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

Returns a new instance of ReadRequest



1506
1507
1508
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1506

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


1504
1505
1506
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1504

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) 


1488
1489
1490
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1488

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:



1498
1499
1500
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1498

def key_set
  @key_set
end

#limit ⇒ String

If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. Corresponds to the JSON property limit

Returns:

  • (String) 


1481
1482
1483
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1481

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


1470
1471
1472
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1470

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) 


1475
1476
1477
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1475

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:



1459
1460
1461
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1459

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1511

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