Class: Google::Apis::ContaineranalysisV1alpha1::Status

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



7958
7959
7960
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 7958

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) 


7943
7944
7945
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 7943

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


7949
7950
7951
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 7949

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) 


7956
7957
7958
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 7956

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7963
7964
7965
7966
7967
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 7963

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