Interface BadRequest.FieldViolationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BadRequest.FieldViolation, BadRequest.FieldViolation.Builder
Enclosing class:
BadRequest
public static interface BadRequest.FieldViolationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    A description of why the request element is bad.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A description of why the request element is bad.
    String
    getField()
    A path that leads to a field in the request body.
    com.google.protobuf.ByteString
    getFieldBytes()
    A path that leads to a field in the request body.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getField

      String getField()
      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.
      string field = 1;
      Returns:
      The field.

    • getFieldBytes

      com.google.protobuf.ByteString getFieldBytes()
      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.
      string field = 1;
      Returns:
      The bytes for field.

    • getDescription

      String getDescription()
      A description of why the request element is bad.
      string description = 2;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
      A description of why the request element is bad.
      string description = 2;
      Returns:
      The bytes for description.