Class: Google::Apis::ApigatewayV1beta::ApigatewayStatus

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



1132
1133
1134
 
# File 'lib/google/apis/apigateway_v1beta/classes.rb', line 1132

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) 


1117
1118
1119
 
# File 'lib/google/apis/apigateway_v1beta/classes.rb', line 1117

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


1123
1124
1125
 
# File 'lib/google/apis/apigateway_v1beta/classes.rb', line 1123

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) 


1130
1131
1132
 
# File 'lib/google/apis/apigateway_v1beta/classes.rb', line 1130

def message
  @message
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1137
1138
1139
1140
1141
 
# File 'lib/google/apis/apigateway_v1beta/classes.rb', line 1137

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