Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::Group (v1.0.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#display_name

def display_name() -> ::String
Returns
  • (::String) — A user-assigned name for this group, used only for display purposes.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — A user-assigned name for this group, used only for display purposes.
Returns
  • (::String) — A user-assigned name for this group, used only for display purposes.

#filter

def filter() -> ::String
Returns
  • (::String) — The filter used to determine which monitored resources belong to this group.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — The filter used to determine which monitored resources belong to this group.
Returns
  • (::String) — The filter used to determine which monitored resources belong to this group.

#is_cluster

def is_cluster() -> ::Boolean
Returns
  • (::Boolean) — If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

#is_cluster=

def is_cluster=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
Returns
  • (::Boolean) — If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#parent_name

def parent_name() -> ::String
Returns
  • (::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, "".

#parent_name=

def parent_name=(value) -> ::String
Parameter
  • value (::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, "".

Returns
  • (::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, "".