Class: Google::Apis::SasportalV1alpha1::SasPortalStatus
- Inherits:
-
Object
- Object
- Google::Apis::SasportalV1alpha1::SasPortalStatus
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/sasportal_v1alpha1/classes.rb,
lib/google/apis/sasportal_v1alpha1/representations.rb,
lib/google/apis/sasportal_v1alpha1/representations.rb
Overview
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. Each Status message contains three pieces of
data: error code, error message, and error details. You can find out more
about this error model and how to work with it in the API Design Guide.
Instance Attribute Summary collapse
-
#code ⇒ Fixnum
The status code, which should be an enum value of google.rpc.Code.
-
#details ⇒ Array<Hash<String,Object>>
A list of messages that carry the error details.
-
#message ⇒ String
A developer-facing error message, which should be in English.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SasPortalStatus
constructor
A new instance of SasPortalStatus.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ SasPortalStatus
Returns a new instance of SasPortalStatus.
1094 1095 1096 |
# File 'lib/google/apis/sasportal_v1alpha1/classes.rb', line 1094 def initialize(**args) update!(**args) end |
Instance Attribute Details
#code ⇒ Fixnum
The status code, which should be an enum value of google.rpc.Code.
Corresponds to the JSON property code
1079 1080 1081 |
# File 'lib/google/apis/sasportal_v1alpha1/classes.rb', line 1079 def code @code end |
#details ⇒ Array<Hash<String,Object>>
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
Corresponds to the JSON property details
1085 1086 1087 |
# File 'lib/google/apis/sasportal_v1alpha1/classes.rb', line 1085 def details @details end |
#message ⇒ 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.
Corresponds to the JSON property message
1092 1093 1094 |
# File 'lib/google/apis/sasportal_v1alpha1/classes.rb', line 1092 def @message end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1099 1100 1101 1102 1103 |
# File 'lib/google/apis/sasportal_v1alpha1/classes.rb', line 1099 def update!(**args) @code = args[:code] if args.key?(:code) @details = args[:details] if args.key?(:details) @message = args[:message] if args.key?(:message) end |