Class MetricDescriptor.Types.MetricDescriptorMetadata (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.10.0
• 2.2.0

public sealed class MetricDescriptor.Types.MetricDescriptorMetadata : IMessage<MetricDescriptor.Types.MetricDescriptorMetadata>, IEquatable<MetricDescriptor.Types.MetricDescriptorMetadata>, IDeepCloneable<MetricDescriptor.Types.MetricDescriptorMetadata>, IBufferMessage, IMessage

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

Inheritance

object > MetricDescriptor.Types.MetricDescriptorMetadata

Implements

IMessageMetricDescriptorTypesMetricDescriptorMetadata, IEquatableMetricDescriptorTypesMetricDescriptorMetadata, IDeepCloneableMetricDescriptorTypesMetricDescriptorMetadata, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

MetricDescriptorMetadata()

public MetricDescriptorMetadata()

MetricDescriptorMetadata(MetricDescriptorMetadata)

public MetricDescriptorMetadata(MetricDescriptor.Types.MetricDescriptorMetadata other)

Parameter
Name	Description
other	MetricDescriptorTypesMetricDescriptorMetadata

Fields

IngestDelayFieldNumber

public const int IngestDelayFieldNumber = 3

Field number for the "ingest_delay" field.

Field Value
Type	Description
int

LaunchStageFieldNumber

public const int LaunchStageFieldNumber = 1

Field number for the "launch_stage" field.

Field Value
Type	Description
int

SamplePeriodFieldNumber

public const int SamplePeriodFieldNumber = 2

Field number for the "sample_period" field.

Field Value
Type	Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
MessageDescriptor

IngestDelay

public Duration IngestDelay { get; set; }

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.

Property Value
Type	Description
Duration

LaunchStage

[Obsolete]
public LaunchStage LaunchStage { get; set; }

Deprecated. Must use the [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage] instead.

Property Value
Type	Description
LaunchStage

Parser

public static MessageParser<MetricDescriptor.Types.MetricDescriptorMetadata> Parser { get; }

Property Value
Type	Description
MessageParserMetricDescriptorTypesMetricDescriptorMetadata

SamplePeriod

public Duration SamplePeriod { get; set; }

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.

Property Value
Type	Description
Duration

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
int	The number of bytes required to write this message to a coded output stream.

Clone()

public MetricDescriptor.Types.MetricDescriptorMetadata Clone()

Creates a deep clone of this object.

Returns
Type	Description
MetricDescriptorTypesMetricDescriptorMetadata	A deep clone of this object.

Equals(MetricDescriptorMetadata)

public bool Equals(MetricDescriptor.Types.MetricDescriptorMetadata other)

Parameter
Name	Description
other	MetricDescriptorTypesMetricDescriptorMetadata

Returns
Type	Description
bool

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
other	object

Returns
Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
int

Overrides

object.GetHashCode()

MergeFrom(MetricDescriptorMetadata)

public void MergeFrom(MetricDescriptor.Types.MetricDescriptorMetadata other)

Merges the given message into this one.

Parameter
Name	Description
other	MetricDescriptorTypesMetricDescriptorMetadata

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
input	CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
output	CodedOutputStream Coded output stream to write the data to. Must not be null.