Class Group (3.55.0) 

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Group

Implements

GroupOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

IS_CLUSTER_FIELD_NUMBER

public static final int IS_CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARENT_NAME_FIELD_NUMBER

public static final int PARENT_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Group getDefaultInstance()
Returns
Type Description
Group

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Group.Builder newBuilder()
Returns
Type Description
Group.Builder

newBuilder(Group prototype)

public static Group.Builder newBuilder(Group prototype)
Parameter
Name Description
prototype Group
Returns
Type Description
Group.Builder

parseDelimitedFrom(InputStream input)

public static Group parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Group
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Group parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Group
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Group parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Group
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Group parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Group
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Group parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Group
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Group parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Group
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Group parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Group
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Group parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Group
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Group parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Group
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Group parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Group
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Group parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Group
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Group parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Group
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Group> parser()
Returns
Type Description
Parser<Group>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Group getDefaultInstanceForType()
Returns
Type Description
Group

getDisplayName()

public String getDisplayName()

A user-assigned name for this group, used only for display purposes.

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

A user-assigned name for this group, used only for display purposes.

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getFilter()

public String getFilter()

The filter used to determine which monitored resources belong to this group.

string filter = 5;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter used to determine which monitored resources belong to this group.

string filter = 5;

Returns
Type Description
ByteString

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;

Returns
Type Description
boolean

The isCluster.

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;

Returns
Type Description
String

The name.

getNameBytes()

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;

Returns
Type Description
ByteString

The bytes for name.

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;

Returns
Type Description
String

The parentName.

getParentNameBytes()

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, parent_name is the empty string, "".

string parent_name = 3;

Returns
Type Description
ByteString

The bytes for parentName.

getParserForType()

public Parser<Group> getParserForType()
Returns
Type Description
Parser<Group>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Group.Builder newBuilderForType()
Returns
Type Description
Group.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Group.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Group.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Group.Builder toBuilder()
Returns
Type Description
Group.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException