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

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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleRpcPreconditionFailureViolation

Returns a new instance of GoogleRpcPreconditionFailureViolation.


5879
5880
5881
# File 'generated/google/apis/apigee_v1/classes.rb', line 5879

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

Instance Attribute Details

#descriptionString

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)

5863
5864
5865
# File 'generated/google/apis/apigee_v1/classes.rb', line 5863

def description
  @description
end

#subjectString

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)

5870
5871
5872
# File 'generated/google/apis/apigee_v1/classes.rb', line 5870

def subject
  @subject
end

#typeString

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)

5877
5878
5879
# File 'generated/google/apis/apigee_v1/classes.rb', line 5877

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5884
5885
5886
5887
5888
# File 'generated/google/apis/apigee_v1/classes.rb', line 5884

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