Class: Google::Apis::ServicemanagementV1::CustomError

Inherits:

Object

• Object
• Google::Apis::ServicemanagementV1::CustomError

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/servicemanagement_v1/classes.rb,
generated/google/apis/servicemanagement_v1/representations.rb,
generated/google/apis/servicemanagement_v1/representations.rb

Overview

Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types:

• google.foo.v1.CustomError
• google.foo.v1.AnotherError

Instance Attribute Summary

• #rules ⇒ Array<Google::Apis::ServicemanagementV1::CustomErrorRule>

  The list of custom error rules that apply to individual API messages.

• #types ⇒ Array<String>

  The list of custom error detail types, e.g.

Instance Method Summary

• #initialize(**args) ⇒ CustomError constructor

  A new instance of CustomError.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CustomError

Returns a new instance of CustomError

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4691

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#rules ⇒ Array<Google::Apis::ServicemanagementV1::CustomErrorRule>

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order. Corresponds to the JSON property rules

Returns:

• (Array<Google::Apis::ServicemanagementV1::CustomErrorRule>)

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4684

def rules
  @rules
end

#types ⇒ Array<String>

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. Corresponds to the JSON property types

Returns:

• (Array<String>)

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4689

def types
  @types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4696

def update!(**args)
  @rules = args[:rules] if args.key?(:rules)
  @types = args[:types] if args.key?(:types)
end