Class MetricDescriptor.MetricDescriptorMetadata (2.50.1) 

public static final class MetricDescriptor.MetricDescriptorMetadata extends GeneratedMessageV3 implements MetricDescriptor.MetricDescriptorMetadataOrBuilder

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

Protobuf type google.api.MetricDescriptor.MetricDescriptorMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MetricDescriptor.MetricDescriptorMetadata

Static Fields

INGEST_DELAY_FIELD_NUMBER

public static final int INGEST_DELAY_FIELD_NUMBER
Field Value
Type Description
int

LAUNCH_STAGE_FIELD_NUMBER

public static final int LAUNCH_STAGE_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_PERIOD_FIELD_NUMBER

public static final int SAMPLE_PERIOD_FIELD_NUMBER
Field Value
Type Description
int

TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_FIELD_NUMBER

public static final int TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetricDescriptor.MetricDescriptorMetadata getDefaultInstance()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata

getDescriptor()

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

newBuilder()

public static MetricDescriptor.MetricDescriptorMetadata.Builder newBuilder()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

newBuilder(MetricDescriptor.MetricDescriptorMetadata prototype)

public static MetricDescriptor.MetricDescriptorMetadata.Builder newBuilder(MetricDescriptor.MetricDescriptorMetadata prototype)
Parameter
Name Description
prototype MetricDescriptor.MetricDescriptorMetadata
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

parseDelimitedFrom(InputStream input)

public static MetricDescriptor.MetricDescriptorMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricDescriptor.MetricDescriptorMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetricDescriptor.MetricDescriptorMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetricDescriptor.MetricDescriptorMetadata> parser()
Returns
Type Description
Parser<MetricDescriptorMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

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.

getParserForType()

public Parser<MetricDescriptor.MetricDescriptorMetadata> getParserForType()
Returns
Type Description
Parser<MetricDescriptorMetadata>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetricDescriptor.MetricDescriptorMetadata.Builder newBuilderForType()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetricDescriptor.MetricDescriptorMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MetricDescriptor.MetricDescriptorMetadata.Builder toBuilder()
Returns
Type Description
MetricDescriptor.MetricDescriptorMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException