lib/google/cloud/redis/v1/doc/google/rpc/status.rb in google-cloud-redis-0.2.3 vs lib/google/cloud/redis/v1/doc/google/rpc/status.rb in google-cloud-redis-0.3.0
- old
+ new
@@ -1,6 +1,6 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
@@ -13,28 +13,29 @@
# limitations under the License.
module Google
module Rpc
- # 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:
+ # 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` that can be used for common error conditions.
+ # 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` that 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
@@ -67,15 +68,17 @@
#
# * Logging. If some API errors are stored in logs, the message `Status` could
# be used directly after any stripping needed for security/privacy reasons.
# @!attribute [rw] code
# @return [Integer]
- # The status code, which should be an enum value of {Google::Rpc::Code}.
+ # The status code, which should be an enum value of
+ # {Google::Rpc::Code}.
# @!attribute [rw] message
# @return [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} field, or localized by the client.
+ # {Google::Rpc::Status#details} field, or localized
+ # by the client.
# @!attribute [rw] details
# @return [Array<Google::Protobuf::Any>]
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
class Status; end
\ No newline at end of file