Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / logging_v1beta3.projects.logServices.sinks.html
blob: dda274c6b0de0c538a14e9bbaddae91638641cba [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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]79<p class="firstline">Creates a log service sink. All log entries from a specified log service are written to the destination.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]82<p class="firstline">Deletes a log service sink. After deletion, no new log entries are written to the destination.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]85<p class="firstline">Gets a log service sink.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(projectsId, logServicesId, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]88<p class="firstline">Lists log service sinks associated with a log service.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]89<p class="toc_element">
90 <code><a href="#update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]91<p class="firstline">Updates a log service sink. If the sink does not exist, it is created.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(projectsId, logServicesId, body, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]95 <pre>Creates a log service sink. All log entries from a specified log service are written to the destination.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]96
97Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]98 projectsId: string, Part of `serviceName`. The resource name of the log service to which the sink is bound. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]103{ # Describes where log entries are written outside of Cloud Logging.
104 "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.
105 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
106 { # Describes a problem with a logging resource or operation.
107 "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.
108 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]109 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
110 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
111 {
112 "a_key": "", # Properties of the object. Contains field @ype with type URL.
113 },
114 ],
115 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]116 "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
117 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]118 },
119 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]120 "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"`.
121 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]122 }
123
124 x__xgafv: string, V1 error format.
125
126Returns:
127 An object of the form:
128
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]129 { # Describes where log entries are written outside of Cloud Logging.
130 "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.
131 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
132 { # Describes a problem with a logging resource or operation.
133 "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.
134 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]135 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
136 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
137 {
138 "a_key": "", # Properties of the object. Contains field @ype with type URL.
139 },
140 ],
141 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]142 "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
143 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]144 },
145 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]146 "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"`.
147 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]153 <pre>Deletes a log service sink. After deletion, no new log entries are written to the destination.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]154
155Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]156 projectsId: string, Part of `sinkName`. The resource name of the log service sink to delete. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]157 logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
158 sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
159 x__xgafv: string, V1 error format.
160
161Returns:
162 An object of the form:
163
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]164 { # 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 `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]165 }</pre>
166</div>
167
168<div class="method">
169 <code class="details" id="get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]170 <pre>Gets a log service sink.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]171
172Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]173 projectsId: string, Part of `sinkName`. The resource name of the log service sink to return. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]174 logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
175 sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
176 x__xgafv: string, V1 error format.
177
178Returns:
179 An object of the form:
180
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]181 { # Describes where log entries are written outside of Cloud Logging.
182 "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.
183 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
184 { # Describes a problem with a logging resource or operation.
185 "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.
186 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]187 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
188 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
189 {
190 "a_key": "", # Properties of the object. Contains field @ype with type URL.
191 },
192 ],
193 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]194 "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
195 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]196 },
197 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]198 "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"`.
199 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="list">list(projectsId, logServicesId, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]205 <pre>Lists log service sinks associated with a log service.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]206
207Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]208 projectsId: string, Part of `serviceName`. The log service whose sinks are wanted. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]209 logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
210 x__xgafv: string, V1 error format.
211
212Returns:
213 An object of the form:
214
215 { # Result returned from `ListLogServiceSinks`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]216 "sinks": [ # The requested log service sinks. If a returned `LogSink` object has an empty `destination` field, the client can retrieve the complete `LogSink` object by calling `logServices.sinks.get`.
217 { # Describes where log entries are written outside of Cloud Logging.
218 "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.
219 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
220 { # Describes a problem with a logging resource or operation.
221 "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.
222 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]223 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
224 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
225 {
226 "a_key": "", # Properties of the object. Contains field @ype with type URL.
227 },
228 ],
229 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]230 "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
231 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]232 },
233 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]234 "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"`.
235 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]236 },
237 ],
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]243 <pre>Updates a log service sink. If the sink does not exist, it is created.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]244
245Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]246 projectsId: string, Part of `sinkName`. The resource name of the log service sink to update. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]247 logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
248 sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
249 body: object, The request body. (required)
250 The object takes the form of:
251
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]252{ # Describes where log entries are written outside of Cloud Logging.
253 "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.
254 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
255 { # Describes a problem with a logging resource or operation.
256 "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.
257 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]258 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
259 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
260 {
261 "a_key": "", # Properties of the object. Contains field @ype with type URL.
262 },
263 ],
264 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]265 "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
266 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]267 },
268 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]269 "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"`.
270 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]271 }
272
273 x__xgafv: string, V1 error format.
274
275Returns:
276 An object of the form:
277
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]278 { # Describes where log entries are written outside of Cloud Logging.
279 "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.
280 "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
281 { # Describes a problem with a logging resource or operation.
282 "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.
283 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]284 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
285 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
286 {
287 "a_key": "", # Properties of the object. Contains field @ype with type URL.
288 },
289 ],
290 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]291 "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
292 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]293 },
294 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]295 "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"`.
296 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]297 }</pre>
298</div>
299
300</body></html>