PHPFUI/InstaDoc
 
Copied!

A message type used to describe a single bad request field.

Generated from protobuf message google.rpc.BadRequest.FieldViolation

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $field
      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.
@type string $description
      A description of why the request element is bad.
@type string $reason
      The reason of the field-level error. This is a constant value that
      identifies the proximate cause of the field-level error. It should
      uniquely identify the type of the FieldViolation within the scope of the
      google.rpc.ErrorInfo.domain. This should be at most 63
      characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`,
      which represents UPPER_SNAKE_CASE.
@type \Google\Rpc\LocalizedMessage $localized_message
      Provides a localized error message for field-level errors that is safe to
      return to the API consumer.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public clearLocalizedMessage()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getDescription()
 

A description of why the request element is bad.

Generated from protobuf field string description = 2;

  • return string
public 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.

Generated from protobuf field string field = 1;

  • return string
public getLocalizedMessage()
 

Provides a localized error message for field-level errors that is safe to return to the API consumer.

Generated from protobuf field .google.rpc.LocalizedMessage localized_message = 4;

  • return \Google\Rpc\LocalizedMessage|null
public getReason()
 

The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

Generated from protobuf field string reason = 3;

  • return string
public hasLocalizedMessage()
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setDescription( $var)
 

A description of why the request element is bad.

Generated from protobuf field string description = 2;

  • param string $var
  • return $this
public setField( $var)
 

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.

Generated from protobuf field string field = 1;

  • param string $var
  • return $this
public setLocalizedMessage( $var)
 

Provides a localized error message for field-level errors that is safe to return to the API consumer.

Generated from protobuf field .google.rpc.LocalizedMessage localized_message = 4;

  • param \Google\Rpc\LocalizedMessage $var
  • return $this
public setReason( $var)
 

The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

Generated from protobuf field string reason = 3;

  • param string $var
  • return $this
Properties
protected $description = ''
 

A description of why the request element is bad.

Generated from protobuf field string description = 2;

protected $field = ''
 

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.

Generated from protobuf field string field = 1;

protected $localized_message = NULL
 

Provides a localized error message for field-level errors that is safe to return to the API consumer.

Generated from protobuf field .google.rpc.LocalizedMessage localized_message = 4;

protected $reason = ''
 

The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

Generated from protobuf field string reason = 3;

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration