Class TextLocator.Builder (3.20.0)

public static final class TextLocator.Builder extends GeneratedMessageV3.Builder<TextLocator.Builder> implements TextLocatorOrBuilder

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

Protobuf type google.monitoring.v3.TextLocator

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TextLocator.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TextLocator.Builder
Overrides

build()

public TextLocator build()
Returns
TypeDescription
TextLocator

buildPartial()

public TextLocator buildPartial()
Returns
TypeDescription
TextLocator

clear()

public TextLocator.Builder clear()
Returns
TypeDescription
TextLocator.Builder
Overrides

clearEndPosition()

public TextLocator.Builder clearEndPosition()

The position of the last byte within the text.

.google.monitoring.v3.TextLocator.Position end_position = 3;

Returns
TypeDescription
TextLocator.Builder

clearField(Descriptors.FieldDescriptor field)

public TextLocator.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TextLocator.Builder
Overrides

clearNestedLocator()

public TextLocator.Builder clearNestedLocator()

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.

.google.monitoring.v3.TextLocator nested_locator = 4;

Returns
TypeDescription
TextLocator.Builder

clearNestingReason()

public TextLocator.Builder clearNestingReason()

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.

string nesting_reason = 5;

Returns
TypeDescription
TextLocator.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TextLocator.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TextLocator.Builder
Overrides

clearSource()

public TextLocator.Builder clearSource()

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

string source = 1;

Returns
TypeDescription
TextLocator.Builder

This builder for chaining.

clearStartPosition()

public TextLocator.Builder clearStartPosition()

The position of the first byte within the text.

.google.monitoring.v3.TextLocator.Position start_position = 2;

Returns
TypeDescription
TextLocator.Builder

clone()

public TextLocator.Builder clone()
Returns
TypeDescription
TextLocator.Builder
Overrides

getDefaultInstanceForType()

public TextLocator getDefaultInstanceForType()
Returns
TypeDescription
TextLocator

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndPosition()

public TextLocator.Position getEndPosition()

The position of the last byte within the text.

.google.monitoring.v3.TextLocator.Position end_position = 3;

Returns
TypeDescription
TextLocator.Position

The endPosition.

getEndPositionBuilder()

public TextLocator.Position.Builder getEndPositionBuilder()

The position of the last byte within the text.

.google.monitoring.v3.TextLocator.Position end_position = 3;

Returns
TypeDescription
TextLocator.Position.Builder

getEndPositionOrBuilder()

public TextLocator.PositionOrBuilder getEndPositionOrBuilder()

The position of the last byte within the text.

.google.monitoring.v3.TextLocator.Position end_position = 3;

Returns
TypeDescription
TextLocator.PositionOrBuilder

getNestedLocator()

public TextLocator getNestedLocator()

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.

.google.monitoring.v3.TextLocator nested_locator = 4;

Returns
TypeDescription
TextLocator

The nestedLocator.

getNestedLocatorBuilder()

public TextLocator.Builder getNestedLocatorBuilder()

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.

.google.monitoring.v3.TextLocator nested_locator = 4;

Returns
TypeDescription
TextLocator.Builder

getNestedLocatorOrBuilder()

public TextLocatorOrBuilder getNestedLocatorOrBuilder()

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.

.google.monitoring.v3.TextLocator nested_locator = 4;

Returns
TypeDescription
TextLocatorOrBuilder

getNestingReason()

public String getNestingReason()

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.

string nesting_reason = 5;

Returns
TypeDescription
String

The nestingReason.

getNestingReasonBytes()

public ByteString getNestingReasonBytes()

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.

string nesting_reason = 5;

Returns
TypeDescription
ByteString

The bytes for nestingReason.

getSource()

public String getSource()

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

string source = 1;

Returns
TypeDescription
String

The source.

getSourceBytes()

public ByteString getSourceBytes()

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

string source = 1;

Returns
TypeDescription
ByteString

The bytes for source.

getStartPosition()

public TextLocator.Position getStartPosition()

The position of the first byte within the text.

.google.monitoring.v3.TextLocator.Position start_position = 2;

Returns
TypeDescription
TextLocator.Position

The startPosition.

getStartPositionBuilder()

public TextLocator.Position.Builder getStartPositionBuilder()

The position of the first byte within the text.

.google.monitoring.v3.TextLocator.Position start_position = 2;

Returns
TypeDescription
TextLocator.Position.Builder

getStartPositionOrBuilder()

public TextLocator.PositionOrBuilder getStartPositionOrBuilder()

The position of the first byte within the text.

.google.monitoring.v3.TextLocator.Position start_position = 2;

Returns
TypeDescription
TextLocator.PositionOrBuilder

hasEndPosition()

public boolean hasEndPosition()

The position of the last byte within the text.

.google.monitoring.v3.TextLocator.Position end_position = 3;

Returns
TypeDescription
boolean

Whether the endPosition field is set.

hasNestedLocator()

public boolean hasNestedLocator()

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.

.google.monitoring.v3.TextLocator nested_locator = 4;

Returns
TypeDescription
boolean

Whether the nestedLocator field is set.

hasStartPosition()

public boolean hasStartPosition()

The position of the first byte within the text.

.google.monitoring.v3.TextLocator.Position start_position = 2;

Returns
TypeDescription
boolean

Whether the startPosition field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEndPosition(TextLocator.Position value)

public TextLocator.Builder mergeEndPosition(TextLocator.Position value)

The position of the last byte within the text.

.google.monitoring.v3.TextLocator.Position end_position = 3;

Parameter
NameDescription
valueTextLocator.Position
Returns
TypeDescription
TextLocator.Builder

mergeFrom(TextLocator other)

public TextLocator.Builder mergeFrom(TextLocator other)
Parameter
NameDescription
otherTextLocator
Returns
TypeDescription
TextLocator.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TextLocator.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TextLocator.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TextLocator.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TextLocator.Builder
Overrides

mergeNestedLocator(TextLocator value)

public TextLocator.Builder mergeNestedLocator(TextLocator value)

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.

.google.monitoring.v3.TextLocator nested_locator = 4;

Parameter
NameDescription
valueTextLocator
Returns
TypeDescription
TextLocator.Builder

mergeStartPosition(TextLocator.Position value)

public TextLocator.Builder mergeStartPosition(TextLocator.Position value)

The position of the first byte within the text.

.google.monitoring.v3.TextLocator.Position start_position = 2;

Parameter
NameDescription
valueTextLocator.Position
Returns
TypeDescription
TextLocator.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TextLocator.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TextLocator.Builder
Overrides

setEndPosition(TextLocator.Position value)

public TextLocator.Builder setEndPosition(TextLocator.Position value)

The position of the last byte within the text.

.google.monitoring.v3.TextLocator.Position end_position = 3;

Parameter
NameDescription
valueTextLocator.Position
Returns
TypeDescription
TextLocator.Builder

setEndPosition(TextLocator.Position.Builder builderForValue)

public TextLocator.Builder setEndPosition(TextLocator.Position.Builder builderForValue)

The position of the last byte within the text.

.google.monitoring.v3.TextLocator.Position end_position = 3;

Parameter
NameDescription
builderForValueTextLocator.Position.Builder
Returns
TypeDescription
TextLocator.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TextLocator.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TextLocator.Builder
Overrides

setNestedLocator(TextLocator value)

public TextLocator.Builder setNestedLocator(TextLocator value)

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.

.google.monitoring.v3.TextLocator nested_locator = 4;

Parameter
NameDescription
valueTextLocator
Returns
TypeDescription
TextLocator.Builder

setNestedLocator(TextLocator.Builder builderForValue)

public TextLocator.Builder setNestedLocator(TextLocator.Builder builderForValue)

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.

.google.monitoring.v3.TextLocator nested_locator = 4;

Parameter
NameDescription
builderForValueTextLocator.Builder
Returns
TypeDescription
TextLocator.Builder

setNestingReason(String value)

public TextLocator.Builder setNestingReason(String value)

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.

string nesting_reason = 5;

Parameter
NameDescription
valueString

The nestingReason to set.

Returns
TypeDescription
TextLocator.Builder

This builder for chaining.

setNestingReasonBytes(ByteString value)

public TextLocator.Builder setNestingReasonBytes(ByteString value)

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.

string nesting_reason = 5;

Parameter
NameDescription
valueByteString

The bytes for nestingReason to set.

Returns
TypeDescription
TextLocator.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TextLocator.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TextLocator.Builder
Overrides

setSource(String value)

public TextLocator.Builder setSource(String value)

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

string source = 1;

Parameter
NameDescription
valueString

The source to set.

Returns
TypeDescription
TextLocator.Builder

This builder for chaining.

setSourceBytes(ByteString value)

public TextLocator.Builder setSourceBytes(ByteString value)

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

string source = 1;

Parameter
NameDescription
valueByteString

The bytes for source to set.

Returns
TypeDescription
TextLocator.Builder

This builder for chaining.

setStartPosition(TextLocator.Position value)

public TextLocator.Builder setStartPosition(TextLocator.Position value)

The position of the first byte within the text.

.google.monitoring.v3.TextLocator.Position start_position = 2;

Parameter
NameDescription
valueTextLocator.Position
Returns
TypeDescription
TextLocator.Builder

setStartPosition(TextLocator.Position.Builder builderForValue)

public TextLocator.Builder setStartPosition(TextLocator.Position.Builder builderForValue)

The position of the first byte within the text.

.google.monitoring.v3.TextLocator.Position start_position = 2;

Parameter
NameDescription
builderForValueTextLocator.Position.Builder
Returns
TypeDescription
TextLocator.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TextLocator.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TextLocator.Builder
Overrides