Class: Google::Apis::DialogflowV3beta1::GoogleRpcStatus

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

Returns a new instance of GoogleRpcStatus.



22500
22501
22502
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 22500

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) 


22485
22486
22487
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 22485

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>>) 


22491
22492
22493
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 22491

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) 


22498
22499
22500
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 22498

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



22505
22506
22507
22508
22509
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 22505

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