Class: Google::Apis::ApigatewayV1::ApigatewayStatus

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

Returns a new instance of ApigatewayStatus.



1051
1052
1053
 
# File 'lib/google/apis/apigateway_v1/classes.rb', line 1051

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) 


1036
1037
1038
 
# File 'lib/google/apis/apigateway_v1/classes.rb', line 1036

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


1042
1043
1044
 
# File 'lib/google/apis/apigateway_v1/classes.rb', line 1042

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) 


1049
1050
1051
 
# File 'lib/google/apis/apigateway_v1/classes.rb', line 1049

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1056
1057
1058
1059
1060
 
# File 'lib/google/apis/apigateway_v1/classes.rb', line 1056

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