Class MetricDescriptor.MetricDescriptorMetadata.Builder (2.48.0)

public static final class MetricDescriptor.MetricDescriptorMetadata.Builder extends GeneratedMessageV3.Builder<MetricDescriptor.MetricDescriptorMetadata.Builder> implements MetricDescriptor.MetricDescriptorMetadataOrBuilder

Additional annotations that can be used to guide the usage of a metric.

Protobuf type google.api.MetricDescriptor.MetricDescriptorMetadata

Static Methods

getDescriptor()

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

Methods

addAllTimeSeriesResourceHierarchyLevel(Iterable<? extends MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel> values)

public MetricDescriptor.MetricDescriptorMetadata.Builder addAllTimeSeriesResourceHierarchyLevel(Iterable<? extends MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel> values)

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Parameter
Name Description
values Iterable<? extends com.google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel>

The timeSeriesResourceHierarchyLevel to add.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

addAllTimeSeriesResourceHierarchyLevelValue(Iterable<Integer> values)

public MetricDescriptor.MetricDescriptorMetadata.Builder addAllTimeSeriesResourceHierarchyLevelValue(Iterable<Integer> values)

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for timeSeriesResourceHierarchyLevel to add.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addTimeSeriesResourceHierarchyLevel(MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel value)

public MetricDescriptor.MetricDescriptorMetadata.Builder addTimeSeriesResourceHierarchyLevel(MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel value)

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Parameter
Name Description
value MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel

The timeSeriesResourceHierarchyLevel to add.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

addTimeSeriesResourceHierarchyLevelValue(int value)

public MetricDescriptor.MetricDescriptorMetadata.Builder addTimeSeriesResourceHierarchyLevelValue(int value)

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for timeSeriesResourceHierarchyLevel to add.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

build()

public MetricDescriptor.MetricDescriptorMetadata build()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata

buildPartial()

public MetricDescriptor.MetricDescriptorMetadata buildPartial()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata

clear()

public MetricDescriptor.MetricDescriptorMetadata.Builder clear()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public MetricDescriptor.MetricDescriptorMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder
Overrides

clearIngestDelay()

public MetricDescriptor.MetricDescriptorMetadata.Builder clearIngestDelay()

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

.google.protobuf.Duration ingest_delay = 3;

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

clearLaunchStage() (deprecated)

public MetricDescriptor.MetricDescriptorMetadata.Builder clearLaunchStage()

Deprecated. google.api.MetricDescriptor.MetricDescriptorMetadata.launch_stage is deprecated. See google/api/metric.proto;l=100

Deprecated. Must use the MetricDescriptor.launch_stage instead.

.google.api.LaunchStage launch_stage = 1 [deprecated = true];

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public MetricDescriptor.MetricDescriptorMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder
Overrides

clearSamplePeriod()

public MetricDescriptor.MetricDescriptorMetadata.Builder clearSamplePeriod()

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

.google.protobuf.Duration sample_period = 2;

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

clearTimeSeriesResourceHierarchyLevel()

public MetricDescriptor.MetricDescriptorMetadata.Builder clearTimeSeriesResourceHierarchyLevel()

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

clone()

public MetricDescriptor.MetricDescriptorMetadata.Builder clone()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder
Overrides

getDefaultInstanceForType()

public MetricDescriptor.MetricDescriptorMetadata getDefaultInstanceForType()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata

getDescriptorForType()

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

getIngestDelay()

public Duration getIngestDelay()

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

.google.protobuf.Duration ingest_delay = 3;

Returns
Type Description
Duration

The ingestDelay.

getIngestDelayBuilder()

public Duration.Builder getIngestDelayBuilder()

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

.google.protobuf.Duration ingest_delay = 3;

Returns
Type Description
Builder

getIngestDelayOrBuilder()

public DurationOrBuilder getIngestDelayOrBuilder()

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

.google.protobuf.Duration ingest_delay = 3;

Returns
Type Description
DurationOrBuilder

getLaunchStage() (deprecated)

public LaunchStage getLaunchStage()

Deprecated. google.api.MetricDescriptor.MetricDescriptorMetadata.launch_stage is deprecated. See google/api/metric.proto;l=100

Deprecated. Must use the MetricDescriptor.launch_stage instead.

.google.api.LaunchStage launch_stage = 1 [deprecated = true];

Returns
Type Description
LaunchStage

The launchStage.

getLaunchStageValue() (deprecated)

public int getLaunchStageValue()

Deprecated. google.api.MetricDescriptor.MetricDescriptorMetadata.launch_stage is deprecated. See google/api/metric.proto;l=100

Deprecated. Must use the MetricDescriptor.launch_stage instead.

.google.api.LaunchStage launch_stage = 1 [deprecated = true];

Returns
Type Description
int

The enum numeric value on the wire for launchStage.

getSamplePeriod()

public Duration getSamplePeriod()

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

.google.protobuf.Duration sample_period = 2;

Returns
Type Description
Duration

The samplePeriod.

getSamplePeriodBuilder()

public Duration.Builder getSamplePeriodBuilder()

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

.google.protobuf.Duration sample_period = 2;

Returns
Type Description
Builder

getSamplePeriodOrBuilder()

public DurationOrBuilder getSamplePeriodOrBuilder()

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

.google.protobuf.Duration sample_period = 2;

Returns
Type Description
DurationOrBuilder

getTimeSeriesResourceHierarchyLevel(int index)

public MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel getTimeSeriesResourceHierarchyLevel(int index)

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel

The timeSeriesResourceHierarchyLevel at the given index.

getTimeSeriesResourceHierarchyLevelCount()

public int getTimeSeriesResourceHierarchyLevelCount()

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Returns
Type Description
int

The count of timeSeriesResourceHierarchyLevel.

getTimeSeriesResourceHierarchyLevelList()

public List<MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel> getTimeSeriesResourceHierarchyLevelList()

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Returns
Type Description
List<TimeSeriesResourceHierarchyLevel>

A list containing the timeSeriesResourceHierarchyLevel.

getTimeSeriesResourceHierarchyLevelValue(int index)

public int getTimeSeriesResourceHierarchyLevelValue(int index)

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of timeSeriesResourceHierarchyLevel at the given index.

getTimeSeriesResourceHierarchyLevelValueList()

public List<Integer> getTimeSeriesResourceHierarchyLevelValueList()

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for timeSeriesResourceHierarchyLevel.

hasIngestDelay()

public boolean hasIngestDelay()

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

.google.protobuf.Duration ingest_delay = 3;

Returns
Type Description
boolean

Whether the ingestDelay field is set.

hasSamplePeriod()

public boolean hasSamplePeriod()

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

.google.protobuf.Duration sample_period = 2;

Returns
Type Description
boolean

Whether the samplePeriod field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetricDescriptor.MetricDescriptorMetadata other)

public MetricDescriptor.MetricDescriptorMetadata.Builder mergeFrom(MetricDescriptor.MetricDescriptorMetadata other)
Parameter
Name Description
other MetricDescriptor.MetricDescriptorMetadata
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public MetricDescriptor.MetricDescriptorMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder
Overrides

mergeIngestDelay(Duration value)

public MetricDescriptor.MetricDescriptorMetadata.Builder mergeIngestDelay(Duration value)

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

.google.protobuf.Duration ingest_delay = 3;

Parameter
Name Description
value Duration
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

mergeSamplePeriod(Duration value)

public MetricDescriptor.MetricDescriptorMetadata.Builder mergeSamplePeriod(Duration value)

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

.google.protobuf.Duration sample_period = 2;

Parameter
Name Description
value Duration
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MetricDescriptor.MetricDescriptorMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setIngestDelay(Duration value)

public MetricDescriptor.MetricDescriptorMetadata.Builder setIngestDelay(Duration value)

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

.google.protobuf.Duration ingest_delay = 3;

Parameter
Name Description
value Duration
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

setIngestDelay(Duration.Builder builderForValue)

public MetricDescriptor.MetricDescriptorMetadata.Builder setIngestDelay(Duration.Builder builderForValue)

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

.google.protobuf.Duration ingest_delay = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

setLaunchStage(LaunchStage value) (deprecated)

public MetricDescriptor.MetricDescriptorMetadata.Builder setLaunchStage(LaunchStage value)

Deprecated. google.api.MetricDescriptor.MetricDescriptorMetadata.launch_stage is deprecated. See google/api/metric.proto;l=100

Deprecated. Must use the MetricDescriptor.launch_stage instead.

.google.api.LaunchStage launch_stage = 1 [deprecated = true];

Parameter
Name Description
value LaunchStage

The launchStage to set.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

setLaunchStageValue(int value) (deprecated)

public MetricDescriptor.MetricDescriptorMetadata.Builder setLaunchStageValue(int value)

Deprecated. google.api.MetricDescriptor.MetricDescriptorMetadata.launch_stage is deprecated. See google/api/metric.proto;l=100

Deprecated. Must use the MetricDescriptor.launch_stage instead.

.google.api.LaunchStage launch_stage = 1 [deprecated = true];

Parameter
Name Description
value int

The enum numeric value on the wire for launchStage to set.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

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

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

setSamplePeriod(Duration value)

public MetricDescriptor.MetricDescriptorMetadata.Builder setSamplePeriod(Duration value)

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

.google.protobuf.Duration sample_period = 2;

Parameter
Name Description
value Duration
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

setSamplePeriod(Duration.Builder builderForValue)

public MetricDescriptor.MetricDescriptorMetadata.Builder setSamplePeriod(Duration.Builder builderForValue)

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

.google.protobuf.Duration sample_period = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

setTimeSeriesResourceHierarchyLevel(int index, MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel value)

public MetricDescriptor.MetricDescriptorMetadata.Builder setTimeSeriesResourceHierarchyLevel(int index, MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel value)

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Parameters
Name Description
index int

The index to set the value at.

value MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel

The timeSeriesResourceHierarchyLevel to set.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

setTimeSeriesResourceHierarchyLevelValue(int index, int value)

public MetricDescriptor.MetricDescriptorMetadata.Builder setTimeSeriesResourceHierarchyLevelValue(int index, int value)

The scope of the timeseries data of the metric.

repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for timeSeriesResourceHierarchyLevel to set.

Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final MetricDescriptor.MetricDescriptorMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder
Overrides