Class TextLocator (2.9.2)

TextLocator(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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


source str
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 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).
The position of the first byte within the text.
The position of the last byte within the text.
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.
nesting_reason str
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.


builtins.object > proto.message.Message > TextLocator



Position(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The position of a byte within the text.