Class: Google::Apis::StorageV1::GoogleRpcStatus

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

Constructor Details

#initialize(**args) ⇒ GoogleRpcStatus

Returns a new instance of GoogleRpcStatus.



1906
1907
1908
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1906

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) 


1893
1894
1895
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1893

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


1899
1900
1901
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1899

def details
  @details
end

#message ⇒ String

A developer-facing error message, which should be in English. Corresponds to the JSON property message

Returns:

  • (String) 


1904
1905
1906
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1904

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1911
1912
1913
1914
1915
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1911

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