Class: Google::Apis::ServiceusageV1::CustomError

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

Returns a new instance of CustomError



685
686
687
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 685

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

Instance Attribute Details

#rules ⇒ Array<Google::Apis::ServiceusageV1::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:



678
679
680
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 678

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


683
684
685
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 683

def types
  @types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



690
691
692
693
 
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 690

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