Class: Google::Rpc::BadRequest::FieldViolation

Inherits:

Object

Object
Google::Rpc::BadRequest::FieldViolation

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 bad request field.

Instance Attribute Summary collapse

#description ⇒ ::String
A description of why the request element is bad.
#field ⇒ ::String
A path that leads to a field in the request body.

Instance Attribute Details

#description ⇒ `::String`

Returns A description of why the request element is bad.

Returns:

(::String) —
A description of why the request element is bad.

# File 'proto_docs/google/rpc/error_details.rb', line 245

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

#field ⇒ `::String`

Returns A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.

Consider the following:

message CreateContactRequest {
  message EmailAddress {
    enum Type {
      TYPE_UNSPECIFIED = 0;
      HOME = 1;
      WORK = 2;
    }

    optional string email = 1;
    repeated EmailType type = 2;
  }

  string full_name = 1;
  repeated EmailAddress email_addresses = 2;
}

In this example, in proto field could take one of the following values:

full_name for a violation in the full_name value
email_addresses[1].email for a violation in the email field of the first email_addresses message
email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.

In JSON, the same values are represented as:

fullName for a violation in the fullName value
emailAddresses[1].email for a violation in the email field of the first emailAddresses message
emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.