Class: Google::Apis::ServiceusageV1beta1::Status

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1beta1/classes.rb,
lib/google/apis/serviceusage_v1beta1/representations.rb,
lib/google/apis/serviceusage_v1beta1/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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Status

Returns a new instance of Status.



6075
6076
6077
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 6075

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

Returns:

  • (Fixnum) 


6060
6061
6062
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 6060

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

Returns:

  • (Array<Hash<String,Object>>) 


6066
6067
6068
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 6066

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

Returns:

  • (String) 


6073
6074
6075
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 6073

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6080
6081
6082
6083
6084
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 6080

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