Class: Google::Apis::SecuritycenterV1p1beta1::Status

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

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Status

Returns a new instance of Status.



1909
1910
1911
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1909

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) 


1894
1895
1896
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1894

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


1900
1901
1902
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1900

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) 


1907
1908
1909
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1907

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1914
1915
1916
1917
1918
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1914

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