Package com.google.monitoring.v3

Class Group

  • All Implemented Interfaces:
    GroupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Group
extends com.google.protobuf.GeneratedMessageV3
implements GroupOrBuilder
     The description of a dynamic collection of monitored resources. Each group
 has a filter that is matched against monitored resources and their associated
 metadata. If a group's filter matches an available monitored resource, then
 that resource is a member of that group.  Groups can contain any number of
 monitored resources, and each monitored resource can be a member of any
 number of groups.

 Groups can be nested in parent-child hierarchies. The `parentName` field
 identifies an optional parent for each group.  If a group has a parent, then
 the only monitored resources available to be matched by the group's filter
 are the resources contained in the parent group.  In other words, a group
 contains the monitored resources that match its filter and the filters of all
 the group's ancestors.  A group without a parent can contain any monitored
 resource.

 For example, consider an infrastructure running a set of instances with two
 user-defined tags: `"environment"` and `"role"`. A parent group has a filter,
 `environment="production"`.  A child of that parent group has a filter,
 `role="transcoder"`.  The parent group contains all instances in the
 production environment, regardless of their roles.  The child group contains
 instances that have the transcoder role *and* are in the production
 environment.

 The monitored resources contained in a group can change at any moment,
 depending on what resources exist and what filters are associated with the
 group and its ancestors.
    Protobuf type google.monitoring.v3.Group
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Group.Builder
      The description of a dynamic collection of monitored resources.

      • 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.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static Group getDefaultInstance()  
      Group getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      String getDisplayName()
      A user-assigned name for this group, used only for display purposes.
      com.google.protobuf.ByteString getDisplayNameBytes()
      A user-assigned name for this group, used only for display purposes.
      String getFilter()
      The filter used to determine which monitored resources belong to this group.
      com.google.protobuf.ByteString getFilterBytes()
      The filter used to determine which monitored resources belong to this group.
      boolean getIsCluster()
      If true, the members of this group are considered to be a cluster.
      String getName()
      Output only.
      com.google.protobuf.ByteString getNameBytes()
      Output only.
      String getParentName()
      The name of the group's parent, if it has one.
      com.google.protobuf.ByteString getParentNameBytes()
      The name of the group's parent, if it has one.
      com.google.protobuf.Parser<Group> getParserForType()  
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Group.Builder newBuilder()  
      static Group.Builder newBuilder​(Group prototype)  
      Group.Builder newBuilderForType()  
      protected Group.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Group parseDelimitedFrom​(InputStream input)  
      static Group parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Group parseFrom​(byte[] data)  
      static Group parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Group parseFrom​(com.google.protobuf.ByteString data)  
      static Group parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Group parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Group parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Group parseFrom​(InputStream input)  
      static Group parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Group parseFrom​(ByteBuffer data)  
      static Group parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Group> parser()  
      Group.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • 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

    • Method Detail

      • 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()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The name of this group. The format is:

     projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

 When creating a group, this field is ignored and a new name is created
 consisting of the project specified in the call to `CreateGroup`
 and a unique `[GROUP_ID]` that is generated automatically.
        string name = 1;
        Specified by:
        getName in interface GroupOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The name of this group. The format is:

     projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

 When creating a group, this field is ignored and a new name is created
 consisting of the project specified in the call to `CreateGroup`
 and a unique `[GROUP_ID]` that is generated automatically.
        string name = 1;
        Specified by:
        getNameBytes in interface GroupOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         A user-assigned name for this group, used only for display purposes.
        string display_name = 2;
        Specified by:
        getDisplayName in interface GroupOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         A user-assigned name for this group, used only for display purposes.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface GroupOrBuilder
        Returns:
        The bytes for displayName.

      • getParentName

        public String getParentName()
         The name of the group's parent, if it has one. The format is:

     projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

 For groups with no parent, `parent_name` is the empty string, `""`.
        string parent_name = 3;
        Specified by:
        getParentName in interface GroupOrBuilder
        Returns:
        The parentName.

      • getParentNameBytes

        public com.google.protobuf.ByteString getParentNameBytes()
         The name of the group's parent, if it has one. The format is:

     projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

 For groups with no parent, `parent_name` is the empty string, `""`.
        string parent_name = 3;
        Specified by:
        getParentNameBytes in interface GroupOrBuilder
        Returns:
        The bytes for parentName.

      • getFilter

        public String getFilter()
         The filter used to determine which monitored resources belong to this
 group.
        string filter = 5;
        Specified by:
        getFilter in interface GroupOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         The filter used to determine which monitored resources belong to this
 group.
        string filter = 5;
        Specified by:
        getFilterBytes in interface GroupOrBuilder
        Returns:
        The bytes for filter.

      • getIsCluster

        public boolean getIsCluster()
         If true, the members of this group are considered to be a cluster.
 The system can perform additional analysis on groups that are clusters.
        bool is_cluster = 6;
        Specified by:
        getIsCluster in interface GroupOrBuilder
        Returns:
        The isCluster.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 Group parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Group getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Group> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public Group getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder