Class: Google::Cloud::Monitoring::V3::TextLocator

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/v3/metric.rb

Overview

A locator for text. Indicates a particular part of the text of a request or of an object referenced in the request.

For example, suppose the request field text contains:

text: "The quick brown fox jumps over the lazy dog."

Then the locator:

source: "text" start_position { line: 1 column: 17 } end_position { line: 1 column: 19 }

refers to the part of the text: "fox".

Defined Under Namespace

Classes: Position

Instance Attribute Summary collapse

Instance Attribute Details

#end_position ⇒ ::Google::Cloud::Monitoring::V3::TextLocator::Position

Returns The position of the last byte within the text.

Returns:



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'proto_docs/google/monitoring/v3/metric.rb', line 242

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

  # The position of a byte within the text.
  # @!attribute [rw] line
  #   @return [::Integer]
  #     The line, starting with 1, where the byte is positioned.
  # @!attribute [rw] column
  #   @return [::Integer]
  #     The column within the line, starting with 1, where the byte is
  #     positioned. This is a byte index even though the text is UTF-8.
  class Position
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#nested_locator ⇒ ::Google::Cloud::Monitoring::V3::TextLocator

Returns If source, start_position, and end_position describe a call on some object (e.g. a macro in the time series query language text) and a location is to be designated in that object's text, nested_locator identifies the location within that object.

Returns:

  • (::Google::Cloud::Monitoring::V3::TextLocator) —

    If source, start_position, and end_position describe a call on some object (e.g. a macro in the time series query language text) and a location is to be designated in that object's text, nested_locator identifies the location within that object.



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'proto_docs/google/monitoring/v3/metric.rb', line 242

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

  # The position of a byte within the text.
  # @!attribute [rw] line
  #   @return [::Integer]
  #     The line, starting with 1, where the byte is positioned.
  # @!attribute [rw] column
  #   @return [::Integer]
  #     The column within the line, starting with 1, where the byte is
  #     positioned. This is a byte index even though the text is UTF-8.
  class Position
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#nesting_reason ⇒ ::String

Returns When nested_locator is set, this field gives the reason for the nesting. Usually, the reason is a macro invocation. In that case, the macro name (including the leading '@') signals the location of the macro call in the text and a macro argument name (including the leading '$') signals the location of the macro argument inside the macro body that got substituted away.

Returns:

  • (::String) —

    When nested_locator is set, this field gives the reason for the nesting. Usually, the reason is a macro invocation. In that case, the macro name (including the leading '@') signals the location of the macro call in the text and a macro argument name (including the leading '$') signals the location of the macro argument inside the macro body that got substituted away.



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'proto_docs/google/monitoring/v3/metric.rb', line 242

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

  # The position of a byte within the text.
  # @!attribute [rw] line
  #   @return [::Integer]
  #     The line, starting with 1, where the byte is positioned.
  # @!attribute [rw] column
  #   @return [::Integer]
  #     The column within the line, starting with 1, where the byte is
  #     positioned. This is a byte index even though the text is UTF-8.
  class Position
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source ⇒ ::String

Returns The source of the text. The source may be a field in the request, in which case its format is the format of the google.rpc.BadRequest.FieldViolation.field field in https://cloud.google.com/apis/design/errors#error_details. It may also be be a source other than the request field (e.g. a macro definition referenced in the text of the query), in which case this is the name of the source (e.g. the macro name).

Returns:

  • (::String) —

    The source of the text. The source may be a field in the request, in which case its format is the format of the google.rpc.BadRequest.FieldViolation.field field in https://cloud.google.com/apis/design/errors#error_details. It may also be be a source other than the request field (e.g. a macro definition referenced in the text of the query), in which case this is the name of the source (e.g. the macro name).



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'proto_docs/google/monitoring/v3/metric.rb', line 242

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

  # The position of a byte within the text.
  # @!attribute [rw] line
  #   @return [::Integer]
  #     The line, starting with 1, where the byte is positioned.
  # @!attribute [rw] column
  #   @return [::Integer]
  #     The column within the line, starting with 1, where the byte is
  #     positioned. This is a byte index even though the text is UTF-8.
  class Position
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#start_position ⇒ ::Google::Cloud::Monitoring::V3::TextLocator::Position

Returns The position of the first byte within the text.

Returns:



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'proto_docs/google/monitoring/v3/metric.rb', line 242

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

  # The position of a byte within the text.
  # @!attribute [rw] line
  #   @return [::Integer]
  #     The line, starting with 1, where the byte is positioned.
  # @!attribute [rw] column
  #   @return [::Integer]
  #     The column within the line, starting with 1, where the byte is
  #     positioned. This is a byte index even though the text is UTF-8.
  class Position
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end