Class: Google::Apis::SasportalV1alpha1::SasPortalStatus
- Inherits:
-
Object
- Object
- Google::Apis::SasportalV1alpha1::SasPortalStatus
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/sasportal_v1alpha1/classes.rb,
generated/google/apis/sasportal_v1alpha1/representations.rb,
generated/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.
1026 1027 1028 |
# File 'generated/google/apis/sasportal_v1alpha1/classes.rb', line 1026 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
1011 1012 1013 |
# File 'generated/google/apis/sasportal_v1alpha1/classes.rb', line 1011 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
1017 1018 1019 |
# File 'generated/google/apis/sasportal_v1alpha1/classes.rb', line 1017 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
1024 1025 1026 |
# File 'generated/google/apis/sasportal_v1alpha1/classes.rb', line 1024 def @message end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1031 1032 1033 1034 1035 |
# File 'generated/google/apis/sasportal_v1alpha1/classes.rb', line 1031 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 |