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| Modifier and Type | Class and Description |
|---|---|
static class |
Group.Builder
The description of a dynamic collection of monitored resources.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
IS_CLUSTER_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PARENT_NAME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
static Group |
getDefaultInstance() |
Group |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
java.lang.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.
|
java.lang.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.
|
java.lang.String |
getName()
Output only.
|
GroupName |
getNameAsGroupName() |
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
java.lang.String |
getParentName()
The name of the group's parent, if it has one.
|
GroupName |
getParentNameAsGroupName() |
com.google.protobuf.ByteString |
getParentNameBytes()
The name of the group's parent, if it has one.
|
com.google.protobuf.Parser<Group> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
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) |
static Group |
parseDelimitedFrom(java.io.InputStream input) |
static Group |
parseDelimitedFrom(java.io.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(java.io.InputStream input) |
static Group |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Group> |
parser() |
Group.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int PARENT_NAME_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int IS_CLUSTER_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public java.lang.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;getName in interface GroupOrBuilderpublic 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;getNameBytes in interface GroupOrBuilderpublic java.lang.String getDisplayName()
A user-assigned name for this group, used only for display purposes.
string display_name = 2;getDisplayName in interface GroupOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
A user-assigned name for this group, used only for display purposes.
string display_name = 2;getDisplayNameBytes in interface GroupOrBuilderpublic java.lang.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, `parentName` is the empty string, `""`.
string parent_name = 3;getParentName in interface GroupOrBuilderpublic 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, `parentName` is the empty string, `""`.
string parent_name = 3;getParentNameBytes in interface GroupOrBuilderpublic java.lang.String getFilter()
The filter used to determine which monitored resources belong to this group.
string filter = 5;getFilter in interface GroupOrBuilderpublic com.google.protobuf.ByteString getFilterBytes()
The filter used to determine which monitored resources belong to this group.
string filter = 5;getFilterBytes in interface GroupOrBuilderpublic 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;getIsCluster in interface GroupOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Group parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Group parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Group parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Group parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Group parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Group parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static Group parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Group parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static Group parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Group parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic Group.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Group.Builder newBuilder()
public static Group.Builder newBuilder(Group prototype)
public Group.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Group.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public final GroupName getNameAsGroupName()
public final GroupName getParentNameAsGroupName()
public static Group getDefaultInstance()
public static com.google.protobuf.Parser<Group> parser()
public com.google.protobuf.Parser<Group> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Group getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder