Class 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, java.io.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:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static 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
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Detail

      • newInstance

        protected java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.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 java.util.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.
      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static MonitoredResourceDescriptor parseFrom​(java.nio.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​(java.io.InputStream input)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static MonitoredResourceDescriptor parseFrom​(java.io.InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static MonitoredResourceDescriptor parseDelimitedFrom​(java.io.InputStream input)
                                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static MonitoredResourceDescriptor parseDelimitedFrom​(java.io.InputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

        public static MonitoredResourceDescriptor parseFrom​(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public MonitoredResourceDescriptor.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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
      • 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