Update docs for 1.4.2 release
diff --git a/docs/dyn/logging_v1beta3.projects.logServices.sinks.html b/docs/dyn/logging_v1beta3.projects.logServices.sinks.html
index 537b61e..dda274c 100644
--- a/docs/dyn/logging_v1beta3.projects.logServices.sinks.html
+++ b/docs/dyn/logging_v1beta3.projects.logServices.sinks.html
@@ -76,35 +76,36 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(projectsId, logServicesId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates the specified log service sink resource.</p>
+<p class="firstline">Creates a log service sink. All log entries from a specified log service are written to the destination.</p>
<p class="toc_element">
<code><a href="#delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes the specified log service sink.</p>
+<p class="firstline">Deletes a log service sink. After deletion, no new log entries are written to the destination.</p>
<p class="toc_element">
<code><a href="#get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the specified log service sink resource.</p>
+<p class="firstline">Gets a log service sink.</p>
<p class="toc_element">
<code><a href="#list">list(projectsId, logServicesId, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists log service sinks associated with the specified service.</p>
+<p class="firstline">Lists log service sinks associated with a log service.</p>
<p class="toc_element">
<code><a href="#update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates or update the specified log service sink resource.</p>
+<p class="firstline">Updates a log service sink. If the sink does not exist, it is created.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(projectsId, logServicesId, body, x__xgafv=None)</code>
- <pre>Creates the specified log service sink resource.
+ <pre>Creates a log service sink. All log entries from a specified log service are written to the destination.
Args:
- projectsId: string, Part of `serviceName`. The name of the service in which to create a sink. (required)
+ projectsId: string, Part of `serviceName`. The resource name of the log service to which the sink is bound. (required)
logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # An object that describes where a log may be written.
- "errors": [ # _Output only._ All active errors found for this sink.
- { # A problem in a sink or the sink's configuration.
- "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
- "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.
+{ # Describes where log entries are written outside of Cloud Logging.
+ "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.
+ "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
+ { # Describes a problem with a logging resource or operation.
+ "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.
+ "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.
"code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
@@ -112,12 +113,12 @@
},
],
},
- "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
- "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.
+ "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
+ "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.
},
],
- "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.
- "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ "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"`.
+ "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.
}
x__xgafv: string, V1 error format.
@@ -125,11 +126,12 @@
Returns:
An object of the form:
- { # An object that describes where a log may be written.
- "errors": [ # _Output only._ All active errors found for this sink.
- { # A problem in a sink or the sink's configuration.
- "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
- "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.
+ { # Describes where log entries are written outside of Cloud Logging.
+ "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.
+ "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
+ { # Describes a problem with a logging resource or operation.
+ "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.
+ "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.
"code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
@@ -137,21 +139,21 @@
},
],
},
- "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
- "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.
+ "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
+ "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.
},
],
- "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.
- "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ "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"`.
+ "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.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
- <pre>Deletes the specified log service sink.
+ <pre>Deletes a log service sink. After deletion, no new log entries are written to the destination.
Args:
- projectsId: string, Part of `sinkName`. The name of the sink to delete. (required)
+ projectsId: string, Part of `sinkName`. The resource name of the log service sink to delete. (required)
logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
x__xgafv: string, V1 error format.
@@ -159,16 +161,16 @@
Returns:
An object of the form:
- { # 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); }
+ { # 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 `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(projectsId, logServicesId, sinksId, x__xgafv=None)</code>
- <pre>Gets the specified log service sink resource.
+ <pre>Gets a log service sink.
Args:
- projectsId: string, Part of `sinkName`. The name of the sink to return. (required)
+ projectsId: string, Part of `sinkName`. The resource name of the log service sink to return. (required)
logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
x__xgafv: string, V1 error format.
@@ -176,11 +178,12 @@
Returns:
An object of the form:
- { # An object that describes where a log may be written.
- "errors": [ # _Output only._ All active errors found for this sink.
- { # A problem in a sink or the sink's configuration.
- "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
- "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.
+ { # Describes where log entries are written outside of Cloud Logging.
+ "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.
+ "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
+ { # Describes a problem with a logging resource or operation.
+ "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.
+ "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.
"code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
@@ -188,21 +191,21 @@
},
],
},
- "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
- "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.
+ "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
+ "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.
},
],
- "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.
- "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ "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"`.
+ "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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectsId, logServicesId, x__xgafv=None)</code>
- <pre>Lists log service sinks associated with the specified service.
+ <pre>Lists log service sinks associated with a log service.
Args:
- projectsId: string, Part of `serviceName`. The name of the service for which to list sinks. (required)
+ projectsId: string, Part of `serviceName`. The log service whose sinks are wanted. (required)
logServicesId: string, Part of `serviceName`. See documentation of `projectsId`. (required)
x__xgafv: string, V1 error format.
@@ -210,12 +213,13 @@
An object of the form:
{ # Result returned from `ListLogServiceSinks`.
- "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.
- { # An object that describes where a log may be written.
- "errors": [ # _Output only._ All active errors found for this sink.
- { # A problem in a sink or the sink's configuration.
- "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
- "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.
+ "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`.
+ { # Describes where log entries are written outside of Cloud Logging.
+ "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.
+ "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
+ { # Describes a problem with a logging resource or operation.
+ "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.
+ "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.
"code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
@@ -223,12 +227,12 @@
},
],
},
- "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
- "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.
+ "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
+ "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.
},
],
- "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.
- "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ "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"`.
+ "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.
},
],
}</pre>
@@ -236,20 +240,21 @@
<div class="method">
<code class="details" id="update">update(projectsId, logServicesId, sinksId, body, x__xgafv=None)</code>
- <pre>Creates or update the specified log service sink resource.
+ <pre>Updates a log service sink. If the sink does not exist, it is created.
Args:
- projectsId: string, Part of `sinkName`. The name of the sink to update. (required)
+ projectsId: string, Part of `sinkName`. The resource name of the log service sink to update. (required)
logServicesId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
sinksId: string, Part of `sinkName`. See documentation of `projectsId`. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # An object that describes where a log may be written.
- "errors": [ # _Output only._ All active errors found for this sink.
- { # A problem in a sink or the sink's configuration.
- "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
- "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.
+{ # Describes where log entries are written outside of Cloud Logging.
+ "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.
+ "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
+ { # Describes a problem with a logging resource or operation.
+ "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.
+ "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.
"code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
@@ -257,12 +262,12 @@
},
],
},
- "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
- "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.
+ "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
+ "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.
},
],
- "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.
- "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ "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"`.
+ "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.
}
x__xgafv: string, V1 error format.
@@ -270,11 +275,12 @@
Returns:
An object of the form:
- { # An object that describes where a log may be written.
- "errors": [ # _Output only._ All active errors found for this sink.
- { # A problem in a sink or the sink's configuration.
- "status": { # Represents the RPC error status for Google APIs. See http://go/errormodel for details. # The description of the last error observed.
- "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.
+ { # Describes where log entries are written outside of Cloud Logging.
+ "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.
+ "errors": [ # _Output only._ If any errors occur when invoking a sink method, then this field contains descriptions of the errors.
+ { # Describes a problem with a logging resource or operation.
+ "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.
+ "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.
"code": 42, # The status code, which should be an enum value of [google.rpc.Code][].
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
@@ -282,12 +288,12 @@
},
],
},
- "timeNanos": "A String", # The last time the error was observed, in nanoseconds since the Unix epoch.
- "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.
+ "timeNanos": "A String", # The time the error was observed, in nanoseconds since the Unix epoch.
+ "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.
},
],
- "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.
- "name": "A String", # The name of this sink. This is a client-assigned identifier for the resource. This is ignored by UpdateLogSink and UpdateLogServicesSink.
+ "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"`.
+ "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.
}</pre>
</div>