Class: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus

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



5232
5233
5234
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5232

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) 


5217
5218
5219
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5217

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


5223
5224
5225
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5223

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) 


5230
5231
5232
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5230

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5237
5238
5239
5240
5241
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5237

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