Package com.google.api

Class MonitoredResourceDescriptor

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.api.MonitoredResourceDescriptor
All Implemented Interfaces:
MonitoredResourceDescriptorOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class MonitoredResourceDescriptor extends com.google.protobuf.GeneratedMessageV3 implements MonitoredResourceDescriptorOrBuilder
 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.
Protobuf type google.api.MonitoredResourceDescriptor
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MonitoredResourceDescriptor.Builder
    An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    LABELS_FIELD_NUMBER
     
    static final int
    LAUNCH_STAGE_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static MonitoredResourceDescriptor
    getDefaultInstance()
     
    MonitoredResourceDescriptor
    getDefaultInstanceForType()
     
    String
    getDescription()
    Optional.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Optional.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    Optional.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Optional.
    LabelDescriptor
    getLabels(int index)
    Required.
    int
    getLabelsCount()
    Required.
    List<LabelDescriptor>
    getLabelsList()
    Required.
    LabelDescriptorOrBuilder
    getLabelsOrBuilder(int index)
    Required.
    List<? extends LabelDescriptorOrBuilder>
    getLabelsOrBuilderList()
    Required.
    LaunchStage
    getLaunchStage()
    Optional.
    int
    getLaunchStageValue()
    Optional.
    String
    getName()
    Optional.
    com.google.protobuf.ByteString
    getNameBytes()
    Optional.
    com.google.protobuf.Parser<MonitoredResourceDescriptor>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getType()
    Required.
    com.google.protobuf.ByteString
    getTypeBytes()
    Required.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MonitoredResourceDescriptor.Builder
    newBuilder()
     
    static MonitoredResourceDescriptor.Builder
    newBuilder(MonitoredResourceDescriptor prototype)
     
    MonitoredResourceDescriptor.Builder
    newBuilderForType()
     
    protected MonitoredResourceDescriptor.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static MonitoredResourceDescriptor
    parseDelimitedFrom(InputStream input)
     
    static MonitoredResourceDescriptor
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MonitoredResourceDescriptor
    parseFrom(byte[] data)
     
    static MonitoredResourceDescriptor
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MonitoredResourceDescriptor
    parseFrom(com.google.protobuf.ByteString data)
     
    static MonitoredResourceDescriptor
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MonitoredResourceDescriptor
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MonitoredResourceDescriptor
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MonitoredResourceDescriptor
    parseFrom(InputStream input)
     
    static MonitoredResourceDescriptor
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MonitoredResourceDescriptor
    parseFrom(ByteBuffer data)
     
    static MonitoredResourceDescriptor
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MonitoredResourceDescriptor>
    parser()
     
    MonitoredResourceDescriptor.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsEquals, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getMessageTypedExtensionOrNull, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public String getName()
       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}"`.
      string name = 5;
      Specified by:
      getName in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       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}"`.
      string name = 5;
      Specified by:
      getNameBytes in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The bytes for name.

    • getType

      public String getType()
       Required. The monitored resource type. For example, the type
 `"cloudsql_database"` represents databases in Google Cloud SQL.
  For a list of types, see [Monitored resource
  types](https://cloud.google.com/monitoring/api/resources)
 and [Logging resource
 types](https://cloud.google.com/logging/docs/api/v2/resource-list).
      string type = 1;
      Specified by:
      getType in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
       Required. The monitored resource type. For example, the type
 `"cloudsql_database"` represents databases in Google Cloud SQL.
  For a list of types, see [Monitored resource
  types](https://cloud.google.com/monitoring/api/resources)
 and [Logging resource
 types](https://cloud.google.com/logging/docs/api/v2/resource-list).
      string type = 1;
      Specified by:
      getTypeBytes in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The bytes for type.

    • getDisplayName

      public String getDisplayName()
       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"`.
      string display_name = 2;
      Specified by:
      getDisplayName in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       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"`.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. A detailed description of the monitored resource type that might
 be used in documentation.
      string description = 3;
      Specified by:
      getDescription in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A detailed description of the monitored resource type that might
 be used in documentation.
      string description = 3;
      Specified by:
      getDescriptionBytes in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The bytes for description.

    • getLabelsList

      public List<LabelDescriptor> getLabelsList()
       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"`.
      repeated .google.api.LabelDescriptor labels = 4;
      Specified by:
      getLabelsList in interface MonitoredResourceDescriptorOrBuilder

    • getLabelsOrBuilderList

      public List<? extends LabelDescriptorOrBuilder> getLabelsOrBuilderList()
       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"`.
      repeated .google.api.LabelDescriptor labels = 4;
      Specified by:
      getLabelsOrBuilderList in interface MonitoredResourceDescriptorOrBuilder

    • getLabelsCount

      public int getLabelsCount()
       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"`.
      repeated .google.api.LabelDescriptor labels = 4;
      Specified by:
      getLabelsCount in interface MonitoredResourceDescriptorOrBuilder

    • getLabels

      public LabelDescriptor getLabels(int index)
       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"`.
      repeated .google.api.LabelDescriptor labels = 4;
      Specified by:
      getLabels in interface MonitoredResourceDescriptorOrBuilder

    • getLabelsOrBuilder

      public LabelDescriptorOrBuilder getLabelsOrBuilder(int index)
       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"`.
      repeated .google.api.LabelDescriptor labels = 4;
      Specified by:
      getLabelsOrBuilder in interface MonitoredResourceDescriptorOrBuilder

    • getLaunchStageValue

      public int getLaunchStageValue()
       Optional. The launch stage of the monitored resource definition.
      .google.api.LaunchStage launch_stage = 7;
      Specified by:
      getLaunchStageValue in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The enum numeric value on the wire for launchStage.

    • getLaunchStage

      public LaunchStage getLaunchStage()
       Optional. The launch stage of the monitored resource definition.
      .google.api.LaunchStage launch_stage = 7;
      Specified by:
      getLaunchStage in interface MonitoredResourceDescriptorOrBuilder
      Returns:
      The launchStage.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MonitoredResourceDescriptor parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MonitoredResourceDescriptor parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MonitoredResourceDescriptor parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public MonitoredResourceDescriptor.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static MonitoredResourceDescriptor.Builder newBuilder()

    • newBuilder

      public static MonitoredResourceDescriptor.Builder newBuilder(MonitoredResourceDescriptor prototype)

    • toBuilder

      public MonitoredResourceDescriptor.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected MonitoredResourceDescriptor.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static MonitoredResourceDescriptor getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MonitoredResourceDescriptor> parser()

    • getParserForType

      public com.google.protobuf.Parser<MonitoredResourceDescriptor> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public MonitoredResourceDescriptor getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder