- 3.54.0 (latest)
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
public static final class Group.Builder extends GeneratedMessageV3.Builder<Group.Builder> implements GroupOrBuilderThe 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Group.BuilderImplements
GroupOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Group.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
build()
public Group build()| Returns | |
|---|---|
| Type | Description |
Group | |
buildPartial()
public Group buildPartial()| Returns | |
|---|---|
| Type | Description |
Group | |
clear()
public Group.Builder clear()| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
clearDisplayName()
public Group.Builder clearDisplayName()A user-assigned name for this group, used only for display purposes.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Group.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
clearFilter()
public Group.Builder clearFilter()The filter used to determine which monitored resources belong to this group.
string filter = 5;
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
clearIsCluster()
public Group.Builder clearIsCluster()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 |
Group.Builder | This builder for chaining. |
clearName()
public Group.Builder clearName()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 |
Group.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Group.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
clearParentName()
public Group.Builder clearParentName()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 |
Group.Builder | This builder for chaining. |
clone()
public Group.Builder clone()| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
getDefaultInstanceForType()
public Group getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Group | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(Group other)
public Group.Builder mergeFrom(Group other)| Parameter | |
|---|---|
| Name | Description |
other | Group |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Group.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Group.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Group.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
setDisplayName(String value)
public Group.Builder setDisplayName(String value)A user-assigned name for this group, used only for display purposes.
string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Group.Builder setDisplayNameBytes(ByteString value)A user-assigned name for this group, used only for display purposes.
string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Group.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
setFilter(String value)
public Group.Builder setFilter(String value)The filter used to determine which monitored resources belong to this group.
string filter = 5;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public Group.Builder setFilterBytes(ByteString value)The filter used to determine which monitored resources belong to this group.
string filter = 5;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setIsCluster(boolean value)
public Group.Builder setIsCluster(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe isCluster to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setName(String value)
public Group.Builder setName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Group.Builder setNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setParentName(String value)
public Group.Builder setParentName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parentName to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setParentNameBytes(ByteString value)
public Group.Builder setParentNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parentName to set. |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Group.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Group.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Group.Builder | |