legacy-libs/google-proto-files/google/monitoring/v3/group.proto

   1 // Copyright 2018 Google LLC.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14 //
  15
  16 syntax = "proto3";
  17
  18 package google.monitoring.v3;
  19
  20 option csharp_namespace = "Google.Cloud.Monitoring.V3";
  21 option go_package = "google.golang.org/genproto/googleapis/monitoring/v3;monitoring";
  22 option java_multiple_files = true;
  23 option java_outer_classname = "GroupProto";
  24 option java_package = "com.google.monitoring.v3";
  25 option php_namespace = "Google\\Cloud\\Monitoring\\V3";
  26
  27 // The description of a dynamic collection of monitored resources. Each group
  28 // has a filter that is matched against monitored resources and their associated
  29 // metadata. If a group's filter matches an available monitored resource, then
  30 // that resource is a member of that group.  Groups can contain any number of
  31 // monitored resources, and each monitored resource can be a member of any
  32 // number of groups.
  33 //
  34 // Groups can be nested in parent-child hierarchies. The `parentName` field
  35 // identifies an optional parent for each group.  If a group has a parent, then
  36 // the only monitored resources available to be matched by the group's filter
  37 // are the resources contained in the parent group.  In other words, a group
  38 // contains the monitored resources that match its filter and the filters of all
  39 // the group's ancestors.  A group without a parent can contain any monitored
  40 // resource.
  41 //
  42 // For example, consider an infrastructure running a set of instances with two
  43 // user-defined tags: `"environment"` and `"role"`. A parent group has a filter,
  44 // `environment="production"`.  A child of that parent group has a filter,
  45 // `role="transcoder"`.  The parent group contains all instances in the
  46 // production environment, regardless of their roles.  The child group contains
  47 // instances that have the transcoder role *and* are in the production
  48 // environment.
  49 //
  50 // The monitored resources contained in a group can change at any moment,
  51 // depending on what resources exist and what filters are associated with the
  52 // group and its ancestors.
  53 message Group {
  54   // Output only. The name of this group. The format is
  55   // `"projects/{project_id_or_number}/groups/{group_id}"`.
  56   // When creating a group, this field is ignored and a new name is created
  57   // consisting of the project specified in the call to `CreateGroup`
  58   // and a unique `{group_id}` that is generated automatically.
  59   string name = 1;
  60
  61   // A user-assigned name for this group, used only for display purposes.
  62   string display_name = 2;
  63
  64   // The name of the group's parent, if it has one.
  65   // The format is `"projects/{project_id_or_number}/groups/{group_id}"`.
  66   // For groups with no parent, `parentName` is the empty string, `""`.
  67   string parent_name = 3;
  68
  69   // The filter used to determine which monitored resources belong to this
  70   // group.
  71   string filter = 5;
  72
  73   // If true, the members of this group are considered to be a cluster.
  74   // The system can perform additional analysis on groups that are clusters.
  75   bool is_cluster = 6;
  76 }