Class MonitoredResourceDescriptor (2.10.0)

public sealed class MonitoredResourceDescriptor : IMessage<MonitoredResourceDescriptor>, IEquatable<MonitoredResourceDescriptor>, IDeepCloneable<MonitoredResourceDescriptor>, IBufferMessage, IMessage

An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.

Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.

Inheritance

object > MonitoredResourceDescriptor

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

MonitoredResourceDescriptor()

public MonitoredResourceDescriptor()

MonitoredResourceDescriptor(MonitoredResourceDescriptor)

public MonitoredResourceDescriptor(MonitoredResourceDescriptor other)
Parameter
Name Description
other MonitoredResourceDescriptor

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 3

Field number for the "description" field.

Field Value
Type Description
int

DisplayNameFieldNumber

public const int DisplayNameFieldNumber = 2

Field number for the "display_name" field.

Field Value
Type Description
int

LabelsFieldNumber

public const int LabelsFieldNumber = 4

Field number for the "labels" field.

Field Value
Type Description
int

LaunchStageFieldNumber

public const int LaunchStageFieldNumber = 7

Field number for the "launch_stage" field.

Field Value
Type Description
int

NameFieldNumber

public const int NameFieldNumber = 5

Field number for the "name" field.

Field Value
Type Description
int

TypeFieldNumber

public const int TypeFieldNumber = 1

Field number for the "type" field.

Field Value
Type Description
int

Properties

Description

public string Description { get; set; }

Optional. A detailed description of the monitored resource type that might be used in documentation.

Property Value
Type Description
string

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

DisplayName

public string DisplayName { get; set; }

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

Property Value
Type Description
string

Labels

public RepeatedField<LabelDescriptor> Labels { get; }

Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".

Property Value
Type Description
RepeatedFieldLabelDescriptor

LaunchStage

public LaunchStage LaunchStage { get; set; }

Optional. The launch stage of the monitored resource definition.

Property Value
Type Description
LaunchStage

Name

public string Name { get; set; }

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

Property Value
Type Description
string

Parser

public static MessageParser<MonitoredResourceDescriptor> Parser { get; }
Property Value
Type Description
MessageParserMonitoredResourceDescriptor

Type

public string Type { get; set; }

Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.

Property Value
Type Description
string

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
int

Clone()

public MonitoredResourceDescriptor Clone()
Returns
Type Description
MonitoredResourceDescriptor

Equals(MonitoredResourceDescriptor)

public bool Equals(MonitoredResourceDescriptor other)
Parameter
Name Description
other MonitoredResourceDescriptor
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(MonitoredResourceDescriptor)

public void MergeFrom(MonitoredResourceDescriptor other)
Parameter
Name Description
other MonitoredResourceDescriptor

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream