Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / alertcenter_v1beta1.v1beta1.html
blob: 06e5c39ec3ab9c0a33208cc6823679a45f91a7b4 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]75<h1><a href="alertcenter_v1beta1.html">Google Workspace Alert Center API</a> . <a href="alertcenter_v1beta1.v1beta1.html">v1beta1</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]81 <code><a href="#getSettings">getSettings(customerId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns customer-level settings.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#updateSettings">updateSettings(body=None, customerId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Updates the customer-level settings.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93 <code class="details" id="getSettings">getSettings(customerId=None, x__xgafv=None)</code>
94 <pre>Returns customer-level settings.
95
96Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]97 customerId: string, Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
102
103Returns:
104 An object of the form:
105
106 { # Customer-level settings.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]107 &quot;notifications&quot;: [ # The list of notifications.
yoshi-code-bot38664e82021-05-29 00:50:02 -0700[diff] [blame]108 { # Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]109 &quot;cloudPubsubTopic&quot;: { # A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. # A Google Cloud Pub/sub topic destination.
110 &quot;payloadFormat&quot;: &quot;A String&quot;, # Optional. The format of the payload that would be sent. If not specified the format will be JSON.
111 &quot;topicName&quot;: &quot;A String&quot;, # The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
112 },
113 },
114 ],
115}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]116</div>
117
118<div class="method">
119 <code class="details" id="updateSettings">updateSettings(body=None, customerId=None, x__xgafv=None)</code>
120 <pre>Updates the customer-level settings.
121
122Args:
123 body: object, The request body.
124 The object takes the form of:
125
126{ # Customer-level settings.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]127 &quot;notifications&quot;: [ # The list of notifications.
yoshi-code-bot38664e82021-05-29 00:50:02 -0700[diff] [blame]128 { # Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]129 &quot;cloudPubsubTopic&quot;: { # A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. # A Google Cloud Pub/sub topic destination.
130 &quot;payloadFormat&quot;: &quot;A String&quot;, # Optional. The format of the payload that would be sent. If not specified the format will be JSON.
131 &quot;topicName&quot;: &quot;A String&quot;, # The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]132 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]133 },
134 ],
135}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]137 customerId: string, Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 x__xgafv: string, V1 error format.
139 Allowed values
140 1 - v1 error format
141 2 - v2 error format
142
143Returns:
144 An object of the form:
145
146 { # Customer-level settings.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]147 &quot;notifications&quot;: [ # The list of notifications.
yoshi-code-bot38664e82021-05-29 00:50:02 -0700[diff] [blame]148 { # Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]149 &quot;cloudPubsubTopic&quot;: { # A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission. # A Google Cloud Pub/sub topic destination.
150 &quot;payloadFormat&quot;: &quot;A String&quot;, # Optional. The format of the payload that would be sent. If not specified the format will be JSON.
151 &quot;topicName&quot;: &quot;A String&quot;, # The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
152 },
153 },
154 ],
155}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156</div>
157
158</body></html>