Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 46a8071fe1d1a112dcc791f61c20fd8306b4061f / . / docs / dyn / logging_v1beta3.projects.sinks.html
blob: 14a891384325a05c30ff0aefd67be0dee81acd50 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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
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.sinks.html">sinks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(projectsId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a project sink. A logs filter determines which log entries are written to the destination.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(projectsId, sinksId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a project sink. After deletion, no new log entries are written to the destination.</p>
83<p class="toc_element">
84 <code><a href="#get">get(projectsId, sinksId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a project sink.</p>
86<p class="toc_element">
87 <code><a href="#list">list(projectsId, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists project sinks associated with a project.</p>
89<p class="toc_element">
90 <code><a href="#update">update(projectsId, sinksId, body, x__xgafv=None)</a></code></p>
91<p class="firstline">Updates a project sink. If the sink does not exist, it is created. The destination, filter, or both may be updated.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(projectsId, body, x__xgafv=None)</code>
95 <pre>Creates a project sink. A logs filter determines which log entries are written to the destination.
96
97Args:
98 projectsId: string, Part of `projectName`. The resource name of the project to which the sink is bound. (required)
99 body: object, The request body. (required)
100 The object takes the form of:
101
102{ # Describes where log entries are written outside of Cloud Logging.
103 "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
104 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
105 { # Describes a problem with a logging resource or operation.
106 "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
107 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
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 time the error was observed, in nanoseconds since the Unix epoch.
116 "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
117 },
118 ],
119 "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
120 "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
121 }
122
123 x__xgafv: string, V1 error format.
124
125Returns:
126 An object of the form:
127
128 { # Describes where log entries are written outside of Cloud Logging.
129 "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
130 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
131 { # Describes a problem with a logging resource or operation.
132 "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
133 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
134 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
135 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
136 {
137 "a_key": "", # Properties of the object. Contains field @ype with type URL.
138 },
139 ],
140 },
141 "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
142 "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
143 },
144 ],
145 "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
146 "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="delete">delete(projectsId, sinksId, x__xgafv=None)</code>
152 <pre>Deletes a project sink. After deletion, no new log entries are written to the destination.
153
154Args:
155 projectsId: string, Part of `sinkName`. The resource name of the project sink to delete. (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); } The JSON representation for `Empty` is empty JSON object `{}`.
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="get">get(projectsId, sinksId, x__xgafv=None)</code>
168 <pre>Gets a project sink.
169
170Args:
171 projectsId: string, Part of `sinkName`. The resource name of the project sink to return. (required)
172 sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
173 x__xgafv: string, V1 error format.
174
175Returns:
176 An object of the form:
177
178 { # Describes where log entries are written outside of Cloud Logging.
179 "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
180 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
181 { # Describes a problem with a logging resource or operation.
182 "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
183 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
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 time the error was observed, in nanoseconds since the Unix epoch.
192 "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
193 },
194 ],
195 "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
196 "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
197 }</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="list">list(projectsId, x__xgafv=None)</code>
202 <pre>Lists project sinks associated with a project.
203
204Args:
205 projectsId: string, Part of `projectName`. The project whose sinks are wanted. (required)
206 x__xgafv: string, V1 error format.
207
208Returns:
209 An object of the form:
210
211 { # Result returned from `ListSinks`.
212 "sinks": [ # The requested sinks. If a returned `LogSink` object has an empty `destination` field, the client can retrieve the complete `LogSink` object by calling `projects.sinks.get`.
213 { # Describes where log entries are written outside of Cloud Logging.
214 "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
215 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
216 { # Describes a problem with a logging resource or operation.
217 "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
218 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
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 time the error was observed, in nanoseconds since the Unix epoch.
227 "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
228 },
229 ],
230 "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
231 "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
232 },
233 ],
234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="update">update(projectsId, sinksId, body, x__xgafv=None)</code>
239 <pre>Updates a project sink. If the sink does not exist, it is created. The destination, filter, or both may be updated.
240
241Args:
242 projectsId: string, Part of `sinkName`. The resource name of the project sink to update. (required)
243 sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
244 body: object, The request body. (required)
245 The object takes the form of:
246
247{ # Describes where log entries are written outside of Cloud Logging.
248 "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
249 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
250 { # Describes a problem with a logging resource or operation.
251 "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
252 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
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 time the error was observed, in nanoseconds since the Unix epoch.
261 "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
262 },
263 ],
264 "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
265 "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
266 }
267
268 x__xgafv: string, V1 error format.
269
270Returns:
271 An object of the form:
272
273 { # Describes where log entries are written outside of Cloud Logging.
274 "filter": "A String", # An advanced logs filter. If present, only log entries matching the filter are written. Only project sinks use this field; log sinks and log service sinks must not include a filter.
275 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
276 { # Describes a problem with a logging resource or operation.
277 "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error description, including a classification code, an error message, and other details.
278 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
279 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
280 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
281 {
282 "a_key": "", # Properties of the object. Contains field @ype with type URL.
283 },
284 ],
285 },
286 "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
287 "resource": "A String", # A resource name associated with this error. For example, the name of a Cloud Storage bucket that has insufficient permissions to be a destination for log entries.
288 },
289 ],
290 "destination": "A String", # The resource name of the destination. Cloud Logging writes designated log entries to this destination. For example, `"storage.googleapis.com/my-output-bucket"`.
291 "name": "A String", # The client-assigned name of this sink. For example, `"my-syslog-sink"`. The name must be unique among the sinks of a similar kind in the project.
292 }</pre>
293</div>
294
295</body></html>