com.google.api.services.monitoring.v3.model

Class Group

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v3.model.Group

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Group
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Modifier and Type	Method and Description
Group	clone()
String	getDisplayName() A user-assigned name for this group, used only for display purposes.
String	getFilter() 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.
String	getName() Output only.
String	getParentName() The name of the group's parent, if it has one.
Group	set(String fieldName, Object value)
Group	setDisplayName(String displayName) A user-assigned name for this group, used only for display purposes.
Group	setFilter(String filter) The filter used to determine which monitored resources belong to this group.
Group	setIsCluster(Boolean isCluster) If true, the members of this group are considered to be a cluster.
Group	setName(String name) Output only.
Group	setParentName(String parentName) The name of the group's parent, if it has one.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Group

public Group()

Method Detail

getDisplayName

public String getDisplayName()

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

Returns:

value or null for none

setDisplayName

public Group setDisplayName(String displayName)

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

Parameters:

displayName - displayName or null for none

getFilter

public String getFilter()

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

Returns:

value or null for none

setFilter

public Group setFilter(String filter)

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

Parameters:

filter - filter or null for none

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.

Returns:

value or null for none

setIsCluster

public Group setIsCluster(Boolean isCluster)

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

Parameters:

isCluster - isCluster or null for none

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.

Returns:

value or null for none

setName

public Group setName(String name)

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.

Parameters:

name - name or null for none

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, "".

Returns:

value or null for none

setParentName

public Group setParentName(String parentName)

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, "".

Parameters:

parentName - parentName or null for none

set

public Group set(String fieldName,
                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Group clone()

Overrides:

clone in class com.google.api.client.json.GenericJson