Class: Google::Apis::DocumentaiV1beta2::GoogleRpcStatus

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



4321
4322
4323
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 4321

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#codeFixnum

The status code, which should be an enum value of google.rpc.Code. Corresponds to the JSON property code

Returns:

  • (Fixnum)


4306
4307
4308
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 4306

def code
  @code
end

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


4312
4313
4314
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 4312

def details
  @details
end

#messageString

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)


4319
4320
4321
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 4319

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4326
4327
4328
4329
4330
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 4326

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