Class: Google::Apis::DisplayvideoV3::Status

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



12287
12288
12289
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12287

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) 


12272
12273
12274
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12272

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


12278
12279
12280
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12278

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) 


12285
12286
12287
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12285

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12292
12293
12294
12295
12296
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 12292

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