Reference documentation and code samples for the Stackdriver Monitoring V3 Client class Group.
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.
Generated from protobuf message google.monitoring.v3.Group
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
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.
↳ display_name
string
A user-assigned name for this group, used only for display purposes.
↳ parent_name
string
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, ""
.
↳ filter
string
The filter used to determine which monitored resources belong to this group.
↳ is_cluster
bool
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
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;
string
setName
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;
var
string
$this
getDisplayName
A user-assigned name for this group, used only for display purposes.
Generated from protobuf field string display_name = 2;
string
setDisplayName
A user-assigned name for this group, used only for display purposes.
Generated from protobuf field string display_name = 2;
var
string
$this
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, ""
.
Generated from protobuf field string parent_name = 3;
string
setParentName
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, ""
.
Generated from protobuf field string parent_name = 3;
var
string
$this
getFilter
The filter used to determine which monitored resources belong to this group.
Generated from protobuf field string filter = 5;
string
setFilter
The filter used to determine which monitored resources belong to this group.
Generated from protobuf field string filter = 5;
var
string
$this
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;
bool
setIsCluster
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;
var
bool
$this
