Group
class Group extends Message
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
Methods
No description
Output only. The name of this group. The format is
"projects/{project_id_or_number}/groups/{group_id}".
Output only. The name of this group. The format is
"projects/{project_id_or_number}/groups/{group_id}".
A user-assigned name for this group, used only for display purposes.
A user-assigned name for this group, used only for display purposes.
The name of the group's parent, if it has one.
The name of the group's parent, if it has one.
The filter used to determine which monitored resources belong to this group.
The filter used to determine which monitored resources belong to this group.
If true, the members of this group are considered to be a cluster.
If true, the members of this group are considered to be a cluster.
Details
at line 78
__construct()
at line 93
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.
Generated from protobuf field string name = 1;
at line 108
setName(string $var)
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.
Generated from protobuf field string name = 1;
at line 120
string
getDisplayName()
A user-assigned name for this group, used only for display purposes.
Generated from protobuf field string display_name = 2;
at line 131
setDisplayName(string $var)
A user-assigned name for this group, used only for display purposes.
Generated from protobuf field string display_name = 2;
at line 145
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, "".
Generated from protobuf field string parent_name = 3;
at line 158
setParentName(string $var)
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, "".
Generated from protobuf field string parent_name = 3;
at line 170
string
getFilter()
The filter used to determine which monitored resources belong to this group.
Generated from protobuf field string filter = 5;
at line 181
setFilter(string $var)
The filter used to determine which monitored resources belong to this group.
Generated from protobuf field string filter = 5;
at line 194
bool
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.
Generated from protobuf field bool is_cluster = 6;
at line 206
setIsCluster(bool $var)
If true, the members of this group are considered to be a cluster.
The system can perform additional analysis on groups that are clusters.
Generated from protobuf field bool is_cluster = 6;