Class: Google::Rpc::PreconditionFailure::Violation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/rpc/error_details.rb

Overview

A message type used to describe a single precondition failure.

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns 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".

Returns:

  • (::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".



187
188
189
190
 
# File 'proto_docs/google/rpc/error_details.rb', line 187

class Violation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#subject ⇒ ::String

Returns 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.

Returns:

  • (::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.



187
188
189
190
 
# File 'proto_docs/google/rpc/error_details.rb', line 187

class Violation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#type ⇒ ::String

Returns 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".

Returns:

  • (::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".



187
188
189
190
 
# File 'proto_docs/google/rpc/error_details.rb', line 187

class Violation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end