Class: Google::Apis::SpannerV1::RequestOptions

Inherits:

Object

• Object
• Google::Apis::SpannerV1::RequestOptions

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

Common request options for various APIs.

Instance Attribute Summary

• #priority ⇒ String

  Priority for the request.

• #request_tag ⇒ String

  A per-request tag which can be applied to queries or reads, used for statistics collection.

• #transaction_tag ⇒ String

  A tag used for statistics collection about this transaction.

Instance Method Summary

• #initialize(**args) ⇒ RequestOptions constructor

  A new instance of RequestOptions.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ RequestOptions

Returns a new instance of RequestOptions.

# File 'lib/google/apis/spanner_v1/classes.rb', line 3706

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

Instance Attribute Details

#priority ⇒ String

Priority for the request. Corresponds to the JSON property priority

Returns:

• (String)

# File 'lib/google/apis/spanner_v1/classes.rb', line 3679

def priority
  @priority
end

#request_tag ⇒ String

A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for request_tag values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string. Corresponds to the JSON property requestTag

Returns:

• (String)

# File 'lib/google/apis/spanner_v1/classes.rb', line 3691

def request_tag
  @request_tag
end

#transaction_tag ⇒ String

A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag will be ignored. Legal characters for transaction_tag values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string. Corresponds to the JSON property transactionTag

Returns:

• (String)

# File 'lib/google/apis/spanner_v1/classes.rb', line 3704

def transaction_tag
  @transaction_tag
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/spanner_v1/classes.rb', line 3711

def update!(**args)
  @priority = args[:priority] if args.key?(:priority)
  @request_tag = args[:request_tag] if args.key?(:request_tag)
  @transaction_tag = args[:transaction_tag] if args.key?(:transaction_tag)
end