BadRequest

Descreve violações em uma solicitação do cliente. Esse tipo de erro se concentra nos aspectos sintáticos da solicitação.

Representação JSON
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
Campos
fieldViolations[]

object (FieldViolation)

Descreve todas as violações em uma solicitação do cliente.

FieldViolation

Um tipo de mensagem usado para descrever um único campo de solicitação inválida.

Representação JSON
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
Campos
field

string

Um caminho que leva a um campo no corpo da solicitação. O valor será uma sequência de identificadores separados por pontos que identificam um campo de buffer de protocolo.

Considere o seguinte:

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

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

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

Neste exemplo, em proto, field pode ter um dos seguintes valores:

  • fullName para uma violação no valor fullName
  • email_addresses[1].email por uma violação no campo email da primeira mensagem email_addresses
  • email_addresses[3].type[2] por uma violação no segundo valor type na terceira mensagem email_addresses.

Em JSON, os mesmos valores são representados como:

  • fullName para uma violação no valor fullName
  • emailAddresses[1].email por uma violação no campo email da primeira mensagem emailAddresses
  • emailAddresses[3].type[2] por uma violação no segundo valor type na terceira mensagem emailAddresses.
description

string

Uma descrição do motivo pelo qual o elemento de solicitação é inválido.

reason

string

O motivo do erro no nível do campo. Esse é um valor constante que identifica a causa próxima do erro no nível do campo. Ele precisa identificar exclusivamente o tipo de FieldViolation no escopo de google.rpc.ErrorInfo.domain. Ele precisa ter no máximo 63 caracteres e corresponder a uma expressão regular de [A-Z][A-Z0-9_]+[A-Z0-9], que representa UPPER_SNAKE_CASE.

localizedMessage

object (LocalizedMessage)

Fornece uma mensagem de erro localizada para erros no nível do campo que pode ser retornada com segurança ao consumidor da API.

LocalizedMessage

Fornece uma mensagem de erro localizada que pode ser retornada ao usuário e anexada a um erro de RPC.

Representação JSON
{
  "locale": string,
  "message": string
}
Campos
locale

string

A localidade usada seguindo a especificação definida em https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Exemplos: "en-US", "fr-CH", "es-MX"

message

string

A mensagem de erro localizada na localidade acima.