Class: Google::Cloud::Spanner::V1::RequestOptions

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/v1/spanner.rb

Overview

Common request options for various APIs.

Defined Under Namespace

Modules: Priority

Instance Attribute Summary collapse

Instance Attribute Details

#priority ⇒ ::Google::Cloud::Spanner::V1::RequestOptions::Priority

Returns Priority for the request.

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 207

class RequestOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The relative priority for requests. Note that priority is not applicable
  # for {::Google::Cloud::Spanner::V1::Spanner::Client#begin_transaction BeginTransaction}.
  #
  # The priority acts as a hint to the Cloud Spanner scheduler and does not
  # guarantee priority or order of execution. For example:
  #
  # * Some parts of a write operation always execute at `PRIORITY_HIGH`,
  #   regardless of the specified priority. This may cause you to see an
  #   increase in high priority workload even when executing a low priority
  #   request. This can also potentially cause a priority inversion where a
  #   lower priority request will be fulfilled ahead of a higher priority
  #   request.
  # * If a transaction contains multiple operations with different priorities,
  #   Cloud Spanner does not guarantee to process the higher priority
  #   operations first. There may be other constraints to satisfy, such as
  #   order of operations.
  module Priority
    # `PRIORITY_UNSPECIFIED` is equivalent to `PRIORITY_HIGH`.
    PRIORITY_UNSPECIFIED = 0

    # This specifies that the request is low priority.
    PRIORITY_LOW = 1

    # This specifies that the request is medium priority.
    PRIORITY_MEDIUM = 2

    # This specifies that the request is high priority.
    PRIORITY_HIGH = 3
  end
end

#request_tag ⇒ ::String

Returns 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.

Returns:

  • (::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.



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 207

class RequestOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The relative priority for requests. Note that priority is not applicable
  # for {::Google::Cloud::Spanner::V1::Spanner::Client#begin_transaction BeginTransaction}.
  #
  # The priority acts as a hint to the Cloud Spanner scheduler and does not
  # guarantee priority or order of execution. For example:
  #
  # * Some parts of a write operation always execute at `PRIORITY_HIGH`,
  #   regardless of the specified priority. This may cause you to see an
  #   increase in high priority workload even when executing a low priority
  #   request. This can also potentially cause a priority inversion where a
  #   lower priority request will be fulfilled ahead of a higher priority
  #   request.
  # * If a transaction contains multiple operations with different priorities,
  #   Cloud Spanner does not guarantee to process the higher priority
  #   operations first. There may be other constraints to satisfy, such as
  #   order of operations.
  module Priority
    # `PRIORITY_UNSPECIFIED` is equivalent to `PRIORITY_HIGH`.
    PRIORITY_UNSPECIFIED = 0

    # This specifies that the request is low priority.
    PRIORITY_LOW = 1

    # This specifies that the request is medium priority.
    PRIORITY_MEDIUM = 2

    # This specifies that the request is high priority.
    PRIORITY_HIGH = 3
  end
end

#transaction_tag ⇒ ::String

Returns 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.

Returns:

  • (::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.



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 207

class RequestOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The relative priority for requests. Note that priority is not applicable
  # for {::Google::Cloud::Spanner::V1::Spanner::Client#begin_transaction BeginTransaction}.
  #
  # The priority acts as a hint to the Cloud Spanner scheduler and does not
  # guarantee priority or order of execution. For example:
  #
  # * Some parts of a write operation always execute at `PRIORITY_HIGH`,
  #   regardless of the specified priority. This may cause you to see an
  #   increase in high priority workload even when executing a low priority
  #   request. This can also potentially cause a priority inversion where a
  #   lower priority request will be fulfilled ahead of a higher priority
  #   request.
  # * If a transaction contains multiple operations with different priorities,
  #   Cloud Spanner does not guarantee to process the higher priority
  #   operations first. There may be other constraints to satisfy, such as
  #   order of operations.
  module Priority
    # `PRIORITY_UNSPECIFIED` is equivalent to `PRIORITY_HIGH`.
    PRIORITY_UNSPECIFIED = 0

    # This specifies that the request is low priority.
    PRIORITY_LOW = 1

    # This specifies that the request is medium priority.
    PRIORITY_MEDIUM = 2

    # This specifies that the request is high priority.
    PRIORITY_HIGH = 3
  end
end