public sealed class TextLocator : IMessage<TextLocator>, IEquatable<TextLocator>, IDeepCloneable<TextLocator>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Monitoring v3 API class TextLocator.
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".
Implements
IMessage<TextLocator>, IEquatable<TextLocator>, IDeepCloneable<TextLocator>, IBufferMessage, IMessageNamespace
Google.Cloud.Monitoring.V3Assembly
Google.Cloud.Monitoring.V3.dll
Constructors
TextLocator()
public TextLocator()
TextLocator(TextLocator)
public TextLocator(TextLocator other)
Parameter | |
---|---|
Name | Description |
other | TextLocator |
Properties
EndPosition
public TextLocator.Types.Position EndPosition { get; set; }
The position of the last byte within the text.
Property Value | |
---|---|
Type | Description |
TextLocator.Types.Position |
NestedLocator
public TextLocator NestedLocator { get; set; }
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.
Property Value | |
---|---|
Type | Description |
TextLocator |
NestingReason
public string NestingReason { get; set; }
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.
Property Value | |
---|---|
Type | Description |
String |
Source
public string Source { get; set; }
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).
Property Value | |
---|---|
Type | Description |
String |
StartPosition
public TextLocator.Types.Position StartPosition { get; set; }
The position of the first byte within the text.
Property Value | |
---|---|
Type | Description |
TextLocator.Types.Position |