1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="monitoring_v3.html">Stackdriver Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.groups.html">groups</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="monitoring_v3.projects.groups.members.html">members()</a></code> 79 </p> 80 <p class="firstline">Returns the members Resource.</p> 81 82 <p class="toc_element"> 83 <code><a href="#create">create(name, body, validateOnly=None, x__xgafv=None)</a></code></p> 84 <p class="firstline">Creates a new group.</p> 85 <p class="toc_element"> 86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 87 <p class="firstline">Deletes an existing group.</p> 88 <p class="toc_element"> 89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 90 <p class="firstline">Gets a single group.</p> 91 <p class="toc_element"> 92 <code><a href="#list">list(name, ancestorsOfGroup=None, descendantsOfGroup=None, pageSize=None, x__xgafv=None, pageToken=None, childrenOfGroup=None)</a></code></p> 93 <p class="firstline">Lists the existing groups.</p> 94 <p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96 <p class="firstline">Retrieves the next page of results.</p> 97 <p class="toc_element"> 98 <code><a href="#update">update(name, body, validateOnly=None, x__xgafv=None)</a></code></p> 99 <p class="firstline">Updates an existing group. You can change any group attributes except name.</p> 100 <h3>Method Details</h3> 101 <div class="method"> 102 <code class="details" id="create">create(name, body, validateOnly=None, x__xgafv=None)</code> 103 <pre>Creates a new group. 104 105 Args: 106 name: string, The project in which to create the group. The format is "projects/{project_id_or_number}". (required) 107 body: object, The request body. (required) 108 The object takes the form of: 109 110 { # 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. 111 "filter": "A String", # The filter used to determine which monitored resources belong to this group. 112 "parentName": "A 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, parentName is the empty string, "". 113 "displayName": "A String", # A user-assigned name for this group, used only for display purposes. 114 "name": "A 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. 115 "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. 116 } 117 118 validateOnly: boolean, If true, validate this request but do not create the group. 119 x__xgafv: string, V1 error format. 120 Allowed values 121 1 - v1 error format 122 2 - v2 error format 123 124 Returns: 125 An object of the form: 126 127 { # 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. 128 "filter": "A String", # The filter used to determine which monitored resources belong to this group. 129 "parentName": "A 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, parentName is the empty string, "". 130 "displayName": "A String", # A user-assigned name for this group, used only for display purposes. 131 "name": "A 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. 132 "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. 133 }</pre> 134 </div> 135 136 <div class="method"> 137 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 138 <pre>Deletes an existing group. 139 140 Args: 141 name: string, The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}". (required) 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146 147 Returns: 148 An object of the form: 149 150 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: 151 # service Foo { 152 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 153 # } 154 # The JSON representation for Empty is empty JSON object {}. 155 }</pre> 156 </div> 157 158 <div class="method"> 159 <code class="details" id="get">get(name, x__xgafv=None)</code> 160 <pre>Gets a single group. 161 162 Args: 163 name: string, The group to retrieve. The format is "projects/{project_id_or_number}/groups/{group_id}". (required) 164 x__xgafv: string, V1 error format. 165 Allowed values 166 1 - v1 error format 167 2 - v2 error format 168 169 Returns: 170 An object of the form: 171 172 { # 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. 173 "filter": "A String", # The filter used to determine which monitored resources belong to this group. 174 "parentName": "A 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, parentName is the empty string, "". 175 "displayName": "A String", # A user-assigned name for this group, used only for display purposes. 176 "name": "A 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. 177 "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. 178 }</pre> 179 </div> 180 181 <div class="method"> 182 <code class="details" id="list">list(name, ancestorsOfGroup=None, descendantsOfGroup=None, pageSize=None, x__xgafv=None, pageToken=None, childrenOfGroup=None)</code> 183 <pre>Lists the existing groups. 184 185 Args: 186 name: string, The project whose groups are to be listed. The format is "projects/{project_id_or_number}". (required) 187 ancestorsOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. 188 descendantsOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth. 189 pageSize: integer, A positive number that is the maximum number of results to return. 190 x__xgafv: string, V1 error format. 191 Allowed values 192 1 - v1 error format 193 2 - v2 error format 194 pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. 195 childrenOfGroup: string, A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty. 196 197 Returns: 198 An object of the form: 199 200 { # The ListGroups response. 201 "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. 202 "group": [ # The groups that match the specified filters. 203 { # 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. 204 "filter": "A String", # The filter used to determine which monitored resources belong to this group. 205 "parentName": "A 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, parentName is the empty string, "". 206 "displayName": "A String", # A user-assigned name for this group, used only for display purposes. 207 "name": "A 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. 208 "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. 209 }, 210 ], 211 }</pre> 212 </div> 213 214 <div class="method"> 215 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 216 <pre>Retrieves the next page of results. 217 218 Args: 219 previous_request: The request for the previous page. (required) 220 previous_response: The response from the request for the previous page. (required) 221 222 Returns: 223 A request object that you can call 'execute()' on to request the next 224 page. Returns None if there are no more items in the collection. 225 </pre> 226 </div> 227 228 <div class="method"> 229 <code class="details" id="update">update(name, body, validateOnly=None, x__xgafv=None)</code> 230 <pre>Updates an existing group. You can change any group attributes except name. 231 232 Args: 233 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. (required) 234 body: object, The request body. (required) 235 The object takes the form of: 236 237 { # 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. 238 "filter": "A String", # The filter used to determine which monitored resources belong to this group. 239 "parentName": "A 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, parentName is the empty string, "". 240 "displayName": "A String", # A user-assigned name for this group, used only for display purposes. 241 "name": "A 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. 242 "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. 243 } 244 245 validateOnly: boolean, If true, validate this request but do not update the existing group. 246 x__xgafv: string, V1 error format. 247 Allowed values 248 1 - v1 error format 249 2 - v2 error format 250 251 Returns: 252 An object of the form: 253 254 { # 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. 255 "filter": "A String", # The filter used to determine which monitored resources belong to this group. 256 "parentName": "A 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, parentName is the empty string, "". 257 "displayName": "A String", # A user-assigned name for this group, used only for display purposes. 258 "name": "A 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. 259 "isCluster": True or False, # If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. 260 }</pre> 261 </div> 262 263 </body></html>
