/
essentialcontacts_v1.folders.contacts.html
371 lines (315 loc) 路 21.3 KB
/
essentialcontacts_v1.folders.contacts.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#compute">compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#compute_next">compute_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a new contact for a resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a contact.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a single contact.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the contacts that have been set on a resource.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a contact. Note: A contact's email address cannot be changed.</p>
<p class="toc_element">
<code><a href="#sendTestMessage">sendTestMessage(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Allows a contact admin to send a test message to contact to verify that it has been configured correctly.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="compute">compute(parent, notificationCategories=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
Args:
parent: string, Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
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)
Allowed values
NOTIFICATION_CATEGORY_UNSPECIFIED - Notification category is unrecognized or unspecified.
ALL - All notifications related to the resource, including notifications pertaining to categories added in the future.
SUSPENSION - Notifications related to imminent account suspension.
SECURITY - Notifications related to security/privacy incidents, notifications, and vulnerabilities.
TECHNICAL - Notifications related to technical events and issues such as outages, errors, or bugs.
BILLING - Notifications related to billing and payments notifications, price updates, errors, or credits.
LEGAL - Notifications related to enforcement actions, regulatory compliance, or government notices.
PRODUCT_UPDATES - Notifications related to new versions, product terms updates, or deprecations.
TECHNICAL_INCIDENTS - Child category of TECHNICAL. If assigned, technical incident notifications will go to these contacts instead of TECHNICAL.
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.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the ComputeContacts method.
"contacts": [ # All contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
{ # A contact that will receive notifications from Google Cloud.
"email": "A String", # Required. The email address to send notifications to. The email address does not need to be a Google Account.
"languageTag": "A String", # Required. 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.
"name": "A String", # Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
"notificationCategorySubscriptions": [ # Required. The categories of notifications that the contact will receive communications for.
"A String",
],
"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.
"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.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="compute_next">compute_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Adds a new contact for a resource.
Args:
parent: string, Required. The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
body: object, The request body.
The object takes the form of:
{ # A contact that will receive notifications from Google Cloud.
"email": "A String", # Required. The email address to send notifications to. The email address does not need to be a Google Account.
"languageTag": "A String", # Required. 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.
"name": "A String", # Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
"notificationCategorySubscriptions": [ # Required. The categories of notifications that the contact will receive communications for.
"A String",
],
"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.
"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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A contact that will receive notifications from Google Cloud.
"email": "A String", # Required. The email address to send notifications to. The email address does not need to be a Google Account.
"languageTag": "A String", # Required. 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.
"name": "A String", # Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
"notificationCategorySubscriptions": [ # Required. The categories of notifications that the contact will receive communications for.
"A String",
],
"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.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a contact.
Args:
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a single contact.
Args:
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A contact that will receive notifications from Google Cloud.
"email": "A String", # Required. The email address to send notifications to. The email address does not need to be a Google Account.
"languageTag": "A String", # Required. 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.
"name": "A String", # Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
"notificationCategorySubscriptions": [ # Required. The categories of notifications that the contact will receive communications for.
"A String",
],
"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.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the contacts that have been set on a resource.
Args:
parent: string, Required. The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id} (required)
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.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the ListContacts method.
"contacts": [ # The contacts for the specified resource.
{ # A contact that will receive notifications from Google Cloud.
"email": "A String", # Required. The email address to send notifications to. The email address does not need to be a Google Account.
"languageTag": "A String", # Required. 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.
"name": "A String", # Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
"notificationCategorySubscriptions": [ # Required. The categories of notifications that the contact will receive communications for.
"A String",
],
"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.
"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.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a contact. Note: A contact's email address cannot be changed.
Args:
name: string, Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} (required)
body: object, The request body.
The object takes the form of:
{ # A contact that will receive notifications from Google Cloud.
"email": "A String", # Required. The email address to send notifications to. The email address does not need to be a Google Account.
"languageTag": "A String", # Required. 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.
"name": "A String", # Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
"notificationCategorySubscriptions": [ # Required. The categories of notifications that the contact will receive communications for.
"A String",
],
"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.
"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.
}
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
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A contact that will receive notifications from Google Cloud.
"email": "A String", # Required. The email address to send notifications to. The email address does not need to be a Google Account.
"languageTag": "A String", # Required. 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.
"name": "A String", # Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}
"notificationCategorySubscriptions": [ # Required. The categories of notifications that the contact will receive communications for.
"A String",
],
"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.
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="sendTestMessage">sendTestMessage(resource, body=None, x__xgafv=None)</code>
<pre>Allows a contact admin to send a test message to contact to verify that it has been configured correctly.
Args:
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)
body: object, The request body.
The object takes the form of:
{ # Request message for the SendTestMessage method.
"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}
"A String",
],
"notificationCategory": "A String", # Required. The notification category to send the test message for. All contacts must be subscribed to this category.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
</body></html>