Class: Google::Apis::ApigeeV1::GoogleRpcPreconditionFailureViolation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Overview

A message type used to describe a single precondition failure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleRpcPreconditionFailureViolation

Returns a new instance of GoogleRpcPreconditionFailureViolation.



12217
12218
12219
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 12217

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

Instance Attribute Details

#description ⇒ String

A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted". Corresponds to the JSON property description

Returns:

  • (String) 


12201
12202
12203
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 12201

def description
  @description
end

#subject ⇒ String

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced. Corresponds to the JSON property subject

Returns:

  • (String) 


12208
12209
12210
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 12208

def subject
  @subject
end

#type ⇒ String

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, " TOS" for "Terms of Service violation". Corresponds to the JSON property type

Returns:

  • (String) 


12215
12216
12217
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 12215

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12222
12223
12224
12225
12226
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 12222

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @subject = args[:subject] if args.key?(:subject)
  @type = args[:type] if args.key?(:type)
end