Class Distribution.Exemplar.Builder (2.39.1)

public static final class Distribution.Exemplar.Builder extends GeneratedMessageV3.Builder<Distribution.Exemplar.Builder> implements Distribution.ExemplarOrBuilder

Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.

Protobuf type google.api.Distribution.Exemplar

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAttachments(Iterable<? extends Any> values)

public Distribution.Exemplar.Builder addAllAttachments(Iterable<? extends Any> values)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
values Iterable<? extends com.google.protobuf.Any>
Returns
Type Description
Distribution.Exemplar.Builder

addAttachments(Any value)

public Distribution.Exemplar.Builder addAttachments(Any value)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
value Any
Returns
Type Description
Distribution.Exemplar.Builder

addAttachments(Any.Builder builderForValue)

public Distribution.Exemplar.Builder addAttachments(Any.Builder builderForValue)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Distribution.Exemplar.Builder

addAttachments(int index, Any value)

public Distribution.Exemplar.Builder addAttachments(int index, Any value)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameters
Name Description
index int
value Any
Returns
Type Description
Distribution.Exemplar.Builder

addAttachments(int index, Any.Builder builderForValue)

public Distribution.Exemplar.Builder addAttachments(int index, Any.Builder builderForValue)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
Distribution.Exemplar.Builder

addAttachmentsBuilder()

public Any.Builder addAttachmentsBuilder()

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
Builder

addAttachmentsBuilder(int index)

public Any.Builder addAttachmentsBuilder(int index)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
index int
Returns
Type Description
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Distribution.Exemplar.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

build()

public Distribution.Exemplar build()
Returns
Type Description
Distribution.Exemplar

buildPartial()

public Distribution.Exemplar buildPartial()
Returns
Type Description
Distribution.Exemplar

clear()

public Distribution.Exemplar.Builder clear()
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

clearAttachments()

public Distribution.Exemplar.Builder clearAttachments()

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
Distribution.Exemplar.Builder

clearField(Descriptors.FieldDescriptor field)

public Distribution.Exemplar.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Distribution.Exemplar.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

clearTimestamp()

public Distribution.Exemplar.Builder clearTimestamp()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
Type Description
Distribution.Exemplar.Builder

clearValue()

public Distribution.Exemplar.Builder clearValue()

Value of the exemplar point. This value determines to which bucket the exemplar belongs.

double value = 1;

Returns
Type Description
Distribution.Exemplar.Builder

This builder for chaining.

clone()

public Distribution.Exemplar.Builder clone()
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

getAttachments(int index)

public Any getAttachments(int index)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
index int
Returns
Type Description
Any

getAttachmentsBuilder(int index)

public Any.Builder getAttachmentsBuilder(int index)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
index int
Returns
Type Description
Builder

getAttachmentsBuilderList()

public List<Any.Builder> getAttachmentsBuilderList()

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
List<Builder>

getAttachmentsCount()

public int getAttachmentsCount()

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
int

getAttachmentsList()

public List<Any> getAttachmentsList()

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
List<Any>

getAttachmentsOrBuilder(int index)

public AnyOrBuilder getAttachmentsOrBuilder(int index)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
index int
Returns
Type Description
AnyOrBuilder

getAttachmentsOrBuilderList()

public List<? extends AnyOrBuilder> getAttachmentsOrBuilderList()

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
List<? extends com.google.protobuf.AnyOrBuilder>

getDefaultInstanceForType()

public Distribution.Exemplar getDefaultInstanceForType()
Returns
Type Description
Distribution.Exemplar

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getTimestamp()

public Timestamp getTimestamp()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
Type Description
Timestamp

The timestamp.

getTimestampBuilder()

public Timestamp.Builder getTimestampBuilder()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
Type Description
Builder

getTimestampOrBuilder()

public TimestampOrBuilder getTimestampOrBuilder()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
Type Description
TimestampOrBuilder

getValue()

public double getValue()

Value of the exemplar point. This value determines to which bucket the exemplar belongs.

double value = 1;

Returns
Type Description
double

The value.

hasTimestamp()

public boolean hasTimestamp()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
Type Description
boolean

Whether the timestamp field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Distribution.Exemplar other)

public Distribution.Exemplar.Builder mergeFrom(Distribution.Exemplar other)
Parameter
Name Description
other Distribution.Exemplar
Returns
Type Description
Distribution.Exemplar.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Distribution.Exemplar.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution.Exemplar.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Distribution.Exemplar.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

mergeTimestamp(Timestamp value)

public Distribution.Exemplar.Builder mergeTimestamp(Timestamp value)

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
Distribution.Exemplar.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Distribution.Exemplar.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

removeAttachments(int index)

public Distribution.Exemplar.Builder removeAttachments(int index)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
index int
Returns
Type Description
Distribution.Exemplar.Builder

setAttachments(int index, Any value)

public Distribution.Exemplar.Builder setAttachments(int index, Any value)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameters
Name Description
index int
value Any
Returns
Type Description
Distribution.Exemplar.Builder

setAttachments(int index, Any.Builder builderForValue)

public Distribution.Exemplar.Builder setAttachments(int index, Any.Builder builderForValue)

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

repeated .google.protobuf.Any attachments = 3;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
Distribution.Exemplar.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Distribution.Exemplar.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

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

public Distribution.Exemplar.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

setTimestamp(Timestamp value)

public Distribution.Exemplar.Builder setTimestamp(Timestamp value)

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
Distribution.Exemplar.Builder

setTimestamp(Timestamp.Builder builderForValue)

public Distribution.Exemplar.Builder setTimestamp(Timestamp.Builder builderForValue)

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Distribution.Exemplar.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Distribution.Exemplar.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

setValue(double value)

public Distribution.Exemplar.Builder setValue(double value)

Value of the exemplar point. This value determines to which bucket the exemplar belongs.

double value = 1;

Parameter
Name Description
value double

The value to set.

Returns
Type Description
Distribution.Exemplar.Builder

This builder for chaining.