Class: Google::Apis::CloudfunctionsV1::Status

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

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Status

Returns a new instance of Status.



1296
1297
1298
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 1296

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)


1281
1282
1283
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 1281

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


1287
1288
1289
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 1287

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)


1294
1295
1296
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 1294

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1301
1302
1303
1304
1305
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 1301

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