Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / logging_v1beta3.projects.logServices.sinks.html
blob: 537b61ee8a3ecbb73392063638c036dcbd8934aa [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[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
75<h1><a href="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logServices.html">logServices</a> . <a href="logging_v1beta3.projects.logServices.sinks.html">sinks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(projectsId, logServicesId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates the specified log service sink resource.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the specified log service sink.</p>
83<p class="toc_element">
84 <code><a href="#get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the specified log service sink resource.</p>
86<p class="toc_element">
87 <code><a href="#list">list(projectsId, logServicesId, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists log service sinks associated with the specified service.</p>
89<p class="toc_element">
90 <code><a href="#update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</a></code></p>
91<p class="firstline">Creates or update the specified log service sink resource.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(projectsId, logServicesId, body, x__xgafv=None)</code>
95 <pre>Creates the specified log service sink resource.
96
97Args:
98 projectsId: string, Part of `serviceName`. The name of the service in which to create a sink. (required)
99 logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
100 body: object, The request body. (required)
101 The object takes the form of:
102
103{ # An object that describes where a log may be written.
104 "errors": [ # _Output only._ All active errors found for this sink.
105 { # A problem in a sink or the sink's configuration.
106 "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
107 "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
108 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
109 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
110 {
111 "a_key": "", # Properties of the object. Contains field @ype with type URL.
112 },
113 ],
114 },
115 "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
116 "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
117 },
118 ],
119 "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
120 "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
121 }
122
123 x__xgafv: string, V1 error format.
124
125Returns:
126 An object of the form:
127
128 { # An object that describes where a log may be written.
129 "errors": [ # _Output only._ All active errors found for this sink.
130 { # A problem in a sink or the sink's configuration.
131 "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
132 "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
133 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
134 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
135 {
136 "a_key": "", # Properties of the object. Contains field @ype with type URL.
137 },
138 ],
139 },
140 "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
141 "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
142 },
143 ],
144 "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
145 "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
151 <pre>Deletes the specified log service sink.
152
153Args:
154 projectsId: string, Part of `sinkName`. The name of the sink to delete. (required)
155 logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
156 sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
157 x__xgafv: string, V1 error format.
158
159Returns:
160 An object of the form:
161
162 { # 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); }
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
168 <pre>Gets the specified log service sink resource.
169
170Args:
171 projectsId: string, Part of `sinkName`. The name of the sink to return. (required)
172 logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
173 sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
174 x__xgafv: string, V1 error format.
175
176Returns:
177 An object of the form:
178
179 { # An object that describes where a log may be written.
180 "errors": [ # _Output only._ All active errors found for this sink.
181 { # A problem in a sink or the sink's configuration.
182 "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
183 "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
184 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
185 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
186 {
187 "a_key": "", # Properties of the object. Contains field @ype with type URL.
188 },
189 ],
190 },
191 "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
192 "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
193 },
194 ],
195 "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
196 "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
197 }</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="list">list(projectsId, logServicesId, x__xgafv=None)</code>
202 <pre>Lists log service sinks associated with the specified service.
203
204Args:
205 projectsId: string, Part of `serviceName`. The name of the service for which to list sinks. (required)
206 logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
207 x__xgafv: string, V1 error format.
208
209Returns:
210 An object of the form:
211
212 { # Result returned from `ListLogServiceSinks`.
213 "sinks": [ # The requested log service sinks. If any of the returned `LogSink` objects have an empty `destination` field, then call `logServices.sinks.get` to retrieve the complete `LogSink` object.
214 { # An object that describes where a log may be written.
215 "errors": [ # _Output only._ All active errors found for this sink.
216 { # A problem in a sink or the sink's configuration.
217 "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
218 "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
219 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
220 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
221 {
222 "a_key": "", # Properties of the object. Contains field @ype with type URL.
223 },
224 ],
225 },
226 "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
227 "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
228 },
229 ],
230 "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
231 "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
232 },
233 ],
234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</code>
239 <pre>Creates or update the specified log service sink resource.
240
241Args:
242 projectsId: string, Part of `sinkName`. The name of the sink to update. (required)
243 logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
244 sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
245 body: object, The request body. (required)
246 The object takes the form of:
247
248{ # An object that describes where a log may be written.
249 "errors": [ # _Output only._ All active errors found for this sink.
250 { # A problem in a sink or the sink's configuration.
251 "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
252 "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
253 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
254 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
255 {
256 "a_key": "", # Properties of the object. Contains field @ype with type URL.
257 },
258 ],
259 },
260 "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
261 "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
262 },
263 ],
264 "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
265 "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
266 }
267
268 x__xgafv: string, V1 error format.
269
270Returns:
271 An object of the form:
272
273 { # An object that describes where a log may be written.
274 "errors": [ # _Output only._ All active errors found for this sink.
275 { # A problem in a sink or the sink's configuration.
276 "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
277 "message": "A String", # A developer-facing error message, which should be in English. The user-facing error message should be localized and stored in the [google.rpc.Status.details][google.rpc.Status.details] field.
278 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
279 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
280 {
281 "a_key": "", # Properties of the object. Contains field @ype with type URL.
282 },
283 ],
284 },
285 "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
286 "resource": "A String", # The resource associated with the error. It may be different from the sink destination. For example, the sink may point to a BigQuery dataset, but the error may refer to a table resource inside the dataset.
287 },
288 ],
289 "destination": "A String", # The resource to send log entries to. The supported sink resource types are: + Google Cloud Storage: `storage.googleapis.com/BUCKET` or `BUCKET.storage.googleapis.com/` + Google BigQuery: `bigquery.googleapis.com/projects/PROJECT/datasets/DATASET` Currently the Cloud Logging API supports at most one sink for each resource type per log or log service resource.
290 "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
291 }</pre>
292</div>
293
294</body></html>