-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
advisorynotifications_v1.organizations.locations.notifications.html
240 lines (213 loc) 路 11.3 KB
/
advisorynotifications_v1.organizations.locations.notifications.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
<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="advisorynotifications_v1.html">Advisory Notifications API</a> . <a href="advisorynotifications_v1.organizations.html">organizations</a> . <a href="advisorynotifications_v1.organizations.locations.html">locations</a> . <a href="advisorynotifications_v1.organizations.locations.notifications.html">notifications</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="#get">get(name, languageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a notification.</p>
<p class="toc_element">
<code><a href="#list">list(parent, languageCode=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists notifications under a given parent.</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>
<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="get">get(name, languageCode=None, x__xgafv=None)</code>
<pre>Gets a notification.
Args:
name: string, Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{projects}/locations/{location}/notifications/{notification}. (required)
languageCode: string, ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A notification object for notifying customers about security and privacy issues.
"createTime": "A String", # Output only. Time the notification was created.
"messages": [ # A list of messages in the notification.
{ # A message which contains notification details.
"attachments": [ # The attachments to download.
{ # Attachment with specific information about the issue.
"csv": { # A representation of a CSV file attachment, as a list of column headers and a list of data rows. # A CSV file attachment. Max size is 10 MB.
"dataRows": [ # The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.
{ # A representation of a single data row in a CSV file.
"entries": [ # The data entries in a CSV file row, as a string array rather than a single comma-separated string.
"A String",
],
},
],
"headers": [ # The list of headers for data columns in a CSV file.
"A String",
],
},
"displayName": "A String", # The title of the attachment.
},
],
"body": { # A message body containing text. # The message content.
"text": { # A text object containing the English text and its localized copies. # The text content of the message body.
"enText": "A String", # The English copy.
"localizationState": "A String", # Status of the localization.
"localizedText": "A String", # The requested localized copy (if applicable).
},
},
"createTime": "A String", # The Message creation timestamp.
"localizationTime": "A String", # Time when Message was localized
},
],
"name": "A String", # The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{project}/locations/{location}/notifications/{notification}.
"notificationType": "A String", # Type of notification
"subject": { # A subject line of a notification. # The subject line of the notification.
"text": { # A text object containing the English text and its localized copies. # The text content.
"enText": "A String", # The English copy.
"localizationState": "A String", # Status of the localization.
"localizedText": "A String", # The requested localized copy (if applicable).
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, languageCode=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists notifications under a given parent.
Args:
parent: string, Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}". (required)
languageCode: string, ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
pageSize: integer, The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.
pageToken: string, A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.
view: string, Specifies which parts of the notification resource should be returned in the response.
Allowed values
NOTIFICATION_VIEW_UNSPECIFIED - Not specified, equivalent to BASIC.
BASIC - Server responses only include title, creation time and Notification ID. Note: for internal use responses also include the last update time, the latest message text and whether notification has attachments.
FULL - Include everything.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response of ListNotifications endpoint.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"notifications": [ # List of notifications under a given parent.
{ # A notification object for notifying customers about security and privacy issues.
"createTime": "A String", # Output only. Time the notification was created.
"messages": [ # A list of messages in the notification.
{ # A message which contains notification details.
"attachments": [ # The attachments to download.
{ # Attachment with specific information about the issue.
"csv": { # A representation of a CSV file attachment, as a list of column headers and a list of data rows. # A CSV file attachment. Max size is 10 MB.
"dataRows": [ # The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.
{ # A representation of a single data row in a CSV file.
"entries": [ # The data entries in a CSV file row, as a string array rather than a single comma-separated string.
"A String",
],
},
],
"headers": [ # The list of headers for data columns in a CSV file.
"A String",
],
},
"displayName": "A String", # The title of the attachment.
},
],
"body": { # A message body containing text. # The message content.
"text": { # A text object containing the English text and its localized copies. # The text content of the message body.
"enText": "A String", # The English copy.
"localizationState": "A String", # Status of the localization.
"localizedText": "A String", # The requested localized copy (if applicable).
},
},
"createTime": "A String", # The Message creation timestamp.
"localizationTime": "A String", # Time when Message was localized
},
],
"name": "A String", # The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{project}/locations/{location}/notifications/{notification}.
"notificationType": "A String", # Type of notification
"subject": { # A subject line of a notification. # The subject line of the notification.
"text": { # A text object containing the English text and its localized copies. # The text content.
"enText": "A String", # The English copy.
"localizationState": "A String", # Status of the localization.
"localizedText": "A String", # The requested localized copy (if applicable).
},
},
},
],
"totalSize": 42, # Estimation of a total number of notifications.
}</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>
</body></html>