Class: Google::Apis::ComputeAlpha::ErrorInfo
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::ErrorInfo
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Describes the cause of the error with structured details. Example of an error
when contacting the "pubsub.googleapis.com" API when it is not enabled: "
reason": "API_DISABLED" "domain": "googleapis.com" "metadata":
"resource": "
projects/123", "service": "pubsub.googleapis.com" This response indicates
that the pubsub.googleapis.com API is not enabled. Example of an error that is
returned when attempting to create a Spanner instance in a region that is out
of stock:
"reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata"
:
"availableRegions": "us-central1,us-east2"
Instance Attribute Summary collapse
-
#domain ⇒ String
The logical grouping to which the "reason" belongs.
-
#metadatas ⇒ Hash<String,String>
Additional structured details about this error.
-
#reason ⇒ String
The reason of the error.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ErrorInfo
constructor
A new instance of ErrorInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ ErrorInfo
Returns a new instance of ErrorInfo.
7878 7879 7880 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 7878 def initialize(**args) update!(**args) end |
Instance Attribute Details
#domain ⇒ String
The logical grouping to which the "reason" belongs. The error domain is
typically the registered service name of the tool or product that generates
the error. Example: "pubsub.googleapis.com". If the error is generated by some
common infrastructure, the error domain must be a globally unique value that
identifies the infrastructure. For Google API infrastructure, the error domain
is "googleapis.com".
Corresponds to the JSON property domain
7859 7860 7861 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 7859 def domain @domain end |
#metadatas ⇒ Hash<String,String>
Additional structured details about this error. Keys should match /[a-zA-Z0-9-
_]/ and be limited to 64 characters in length. When identifying the current
value of an exceeded limit, the units should be contained in the key, not the
value. For example, rather than "instanceLimit": "100/request"
, should be
returned as, "instanceLimitPerRequest": "100"
, if the client exceeds the
number of instances that can be created in a single (batch) request.
Corresponds to the JSON property metadatas
7869 7870 7871 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 7869 def @metadatas end |
#reason ⇒ String
The reason of the error. This is a constant value that identifies the
proximate cause of the error. Error reasons are unique within a particular
domain of errors. This should be at most 63 characters and match /[A-Z0-9_]+/.
Corresponds to the JSON property reason
7876 7877 7878 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 7876 def reason @reason end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7883 7884 7885 7886 7887 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 7883 def update!(**args) @domain = args[:domain] if args.key?(:domain) @metadatas = args[:metadatas] if args.key?(:metadatas) @reason = args[:reason] if args.key?(:reason) end |