1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="essentialcontacts_v1.html">Essential Contacts API</a> . <a href="essentialcontacts_v1.folders.html">folders</a> . <a href="essentialcontacts_v1.folders.contacts.html">contacts</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#compute">compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.</p> 83<p class="toc_element"> 84 <code><a href="#compute_next">compute_next(previous_request, previous_response)</a></code></p> 85<p class="firstline">Retrieves the next page of results.</p> 86<p class="toc_element"> 87 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Adds a new contact for a resource.</p> 89<p class="toc_element"> 90 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Deletes a contact.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Gets a single contact.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists the contacts that have been set on a resource.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates a contact. Note: A contact's email address cannot be changed.</p> 104<p class="toc_element"> 105 <code><a href="#sendTestMessage">sendTestMessage(resource, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Allows a contact admin to send a test message to contact to verify that it has been configured correctly.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="close">close()</code> 110 <pre>Close httplib2 connections.</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="compute">compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 115 <pre>Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources. 116 117Args: 118 parent: string, Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required) 119 notificationCategories: string, The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned. (repeated) 120 Allowed values 121 NOTIFICATION_CATEGORY_UNSPECIFIED - Notification category is unrecognized or unspecified. 122 ALL - All notifications related to the resource, including notifications pertaining to categories added in the future. 123 SUSPENSION - Notifications related to imminent account suspension. 124 SECURITY - Notifications related to security/privacy incidents, notifications, and vulnerabilities. 125 TECHNICAL - Notifications related to technical events and issues such as outages, errors, or bugs. 126 BILLING - Notifications related to billing and payments notifications, price updates, errors, or credits. 127 LEGAL - Notifications related to enforcement actions, regulatory compliance, or government notices. 128 PRODUCT_UPDATES - Notifications related to new versions, product terms updates, or deprecations. 129 TECHNICAL_INCIDENTS - Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL. 130 pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100. 131 pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call. 132 x__xgafv: string, V1 error format. 133 Allowed values 134 1 - v1 error format 135 2 - v2 error format 136 137Returns: 138 An object of the form: 139 140 { # Response message for the ComputeContacts method. 141 "contacts": [ # All contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources. 142 { # A contact that will receive notifications from Google Cloud. 143 "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account. 144 "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. 145 "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} 146 "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for. 147 "A String", 148 ], 149 "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. 150 "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. 151 }, 152 ], 153 "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. 154}</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="compute_next">compute_next(previous_request, previous_response)</code> 159 <pre>Retrieves the next page of results. 160 161Args: 162 previous_request: The request for the previous page. (required) 163 previous_response: The response from the request for the previous page. (required) 164 165Returns: 166 A request object that you can call 'execute()' on to request the next 167 page. Returns None if there are no more items in the collection. 168 </pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 173 <pre>Adds a new contact for a resource. 174 175Args: 176 parent: string, Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required) 177 body: object, The request body. 178 The object takes the form of: 179 180{ # A contact that will receive notifications from Google Cloud. 181 "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account. 182 "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. 183 "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} 184 "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for. 185 "A String", 186 ], 187 "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. 188 "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. 189} 190 191 x__xgafv: string, V1 error format. 192 Allowed values 193 1 - v1 error format 194 2 - v2 error format 195 196Returns: 197 An object of the form: 198 199 { # A contact that will receive notifications from Google Cloud. 200 "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account. 201 "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. 202 "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} 203 "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for. 204 "A String", 205 ], 206 "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. 207 "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. 208}</pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 213 <pre>Deletes a contact. 214 215Args: 216 name: string, Required. The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} (required) 217 x__xgafv: string, V1 error format. 218 Allowed values 219 1 - v1 error format 220 2 - v2 error format 221 222Returns: 223 An object of the form: 224 225 { # 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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 226}</pre> 227</div> 228 229<div class="method"> 230 <code class="details" id="get">get(name, x__xgafv=None)</code> 231 <pre>Gets a single contact. 232 233Args: 234 name: string, Required. The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} (required) 235 x__xgafv: string, V1 error format. 236 Allowed values 237 1 - v1 error format 238 2 - v2 error format 239 240Returns: 241 An object of the form: 242 243 { # A contact that will receive notifications from Google Cloud. 244 "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account. 245 "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. 246 "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} 247 "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for. 248 "A String", 249 ], 250 "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. 251 "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. 252}</pre> 253</div> 254 255<div class="method"> 256 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 257 <pre>Lists the contacts that have been set on a resource. 258 259Args: 260 parent: string, Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required) 261 pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100. 262 pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call. 263 x__xgafv: string, V1 error format. 264 Allowed values 265 1 - v1 error format 266 2 - v2 error format 267 268Returns: 269 An object of the form: 270 271 { # Response message for the ListContacts method. 272 "contacts": [ # The contacts for the specified resource. 273 { # A contact that will receive notifications from Google Cloud. 274 "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account. 275 "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. 276 "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} 277 "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for. 278 "A String", 279 ], 280 "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. 281 "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. 282 }, 283 ], 284 "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. 285}</pre> 286</div> 287 288<div class="method"> 289 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 290 <pre>Retrieves the next page of results. 291 292Args: 293 previous_request: The request for the previous page. (required) 294 previous_response: The response from the request for the previous page. (required) 295 296Returns: 297 A request object that you can call 'execute()' on to request the next 298 page. Returns None if there are no more items in the collection. 299 </pre> 300</div> 301 302<div class="method"> 303 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 304 <pre>Updates a contact. Note: A contact's email address cannot be changed. 305 306Args: 307 name: string, The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} (required) 308 body: object, The request body. 309 The object takes the form of: 310 311{ # A contact that will receive notifications from Google Cloud. 312 "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account. 313 "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. 314 "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} 315 "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for. 316 "A String", 317 ], 318 "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. 319 "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. 320} 321 322 updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask 323 x__xgafv: string, V1 error format. 324 Allowed values 325 1 - v1 error format 326 2 - v2 error format 327 328Returns: 329 An object of the form: 330 331 { # A contact that will receive notifications from Google Cloud. 332 "email": "A String", # Required. The email address to send notifications to. This does not need to be a Google account. 333 "languageTag": "A String", # The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. 334 "name": "A String", # The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} 335 "notificationCategorySubscriptions": [ # The categories of notifications that the contact will receive communications for. 336 "A String", 337 ], 338 "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. 339 "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. 340}</pre> 341</div> 342 343<div class="method"> 344 <code class="details" id="sendTestMessage">sendTestMessage(resource, body=None, x__xgafv=None)</code> 345 <pre>Allows a contact admin to send a test message to contact to verify that it has been configured correctly. 346 347Args: 348 resource: string, Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required) 349 body: object, The request body. 350 The object takes the form of: 351 352{ # Request message for the SendTestMessage method. 353 "contacts": [ # Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id} 354 "A String", 355 ], 356 "notificationCategory": "A String", # Required. The notification category to send the test message for. All contacts must be subscribed to this category. 357} 358 359 x__xgafv: string, V1 error format. 360 Allowed values 361 1 - v1 error format 362 2 - v2 error format 363 364Returns: 365 An object of the form: 366 367 { # 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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 368}</pre> 369</div> 370 371</body></html>