public final class Group extends 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.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, 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 |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
static Group |
getDefaultInstance() |
Group |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
java.lang.String |
getDisplayName()
A user-assigned name for this group, used only for display purposes.
|
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.
|
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.
|
ByteString |
getNameBytes()
Output only.
|
java.lang.String |
getParentName()
The name of the group's parent, if it has one.
|
ByteString |
getParentNameBytes()
The name of the group's parent, if it has one.
|
Parser<Group> |
getParserForType() |
int |
getSerializedSize() |
UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Group.Builder |
newBuilder() |
static Group.Builder |
newBuilder(Group prototype) |
Group.Builder |
newBuilderForType() |
protected Group.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
static Group |
parseDelimitedFrom(java.io.InputStream input) |
static Group |
parseDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Group |
parseFrom(byte[] data) |
static Group |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static Group |
parseFrom(java.nio.ByteBuffer data) |
static Group |
parseFrom(java.nio.ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static Group |
parseFrom(ByteString data) |
static Group |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static Group |
parseFrom(CodedInputStream input) |
static Group |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static Group |
parseFrom(java.io.InputStream input) |
static Group |
parseFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<Group> |
parser() |
Group.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public 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 UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public 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 GroupOrBuilder
public 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 GroupOrBuilder
public java.lang.String getDisplayName()
A user-assigned name for this group, used only for display purposes.
string display_name = 2;
getDisplayName
in interface GroupOrBuilder
public ByteString getDisplayNameBytes()
A user-assigned name for this group, used only for display purposes.
string display_name = 2;
getDisplayNameBytes
in interface GroupOrBuilder
public 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 GroupOrBuilder
public 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 GroupOrBuilder
public java.lang.String getFilter()
The filter used to determine which monitored resources belong to this group.
string filter = 5;
getFilter
in interface GroupOrBuilder
public ByteString getFilterBytes()
The filter used to determine which monitored resources belong to this group.
string filter = 5;
getFilterBytes
in interface GroupOrBuilder
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;
getIsCluster
in interface GroupOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws java.io.IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static Group parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Group parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Group parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Group parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Group parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Group parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Group parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Group parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Group parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Group parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Group parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOException
public static Group parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public Group.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static Group.Builder newBuilder()
public static Group.Builder newBuilder(Group prototype)
public Group.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected Group.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static Group getDefaultInstance()
public Parser<Group> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public Group getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder