class Google::Apis::SpannerV1::ReadRequest

The request for Read and StreamingRead.

Attributes

columns[RW]

Required. The columns of table to be returned for each row matching this request. Corresponds to the JSON property `columns` @return [Array<String>]

index[RW]

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` @return [String]

key_set[RW]

`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` @return [Google::Apis::SpannerV1::KeySet]

limit[RW]

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` @return [Fixnum]

partition_token[RW]

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. @return [String]

request_options[RW]

Common request options for various APIs. Corresponds to the JSON property `requestOptions` @return [Google::Apis::SpannerV1::RequestOptions]

resume_token[RW]

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. @return [String]

table[RW]

Required. The name of the table in the database to be read. Corresponds to the JSON property `table` @return [String]

transaction[RW]

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` @return [Google::Apis::SpannerV1::TransactionSelector]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/spanner_v1/classes.rb, line 3260
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/spanner_v1/classes.rb, line 3265
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)
  @limit = args[:limit] if args.key?(:limit)
  @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