Class: Google::Apis::SpeechV1::Status

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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Status

Returns a new instance of Status.



717
718
719
 
# File 'generated/google/apis/speech_v1/classes.rb', line 717

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) 


702
703
704
 
# File 'generated/google/apis/speech_v1/classes.rb', line 702

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


708
709
710
 
# File 'generated/google/apis/speech_v1/classes.rb', line 708

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) 


715
716
717
 
# File 'generated/google/apis/speech_v1/classes.rb', line 715

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



722
723
724
725
726
 
# File 'generated/google/apis/speech_v1/classes.rb', line 722

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