MAINHACK

Viewing / Editing File: FieldViolation.php

<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/rpc/error_details.proto

namespace Google\Rpc\BadRequest;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;

/**
 * A message type used to describe a single bad request field.
 *
 * Generated from protobuf message <code>google.rpc.BadRequest.FieldViolation</code>
 */
class FieldViolation extends \Google\Protobuf\Internal\Message
{
    /**
     * 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 <code>string field = 1;</code>
     */
    protected $field = '';
    /**
     * A description of why the request element is bad.
     *
     * Generated from protobuf field <code>string description = 2;</code>
     */
    protected $description = '';

/**
     * 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.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Rpc\ErrorDetails::initOnce();
        parent::__construct($data);
    }

/**
     * 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 <code>string field = 1;</code>
     * @return string
     */
    public function getField()
    {
        return $this->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 <code>string field = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setField($var)
    {
        GPBUtil::checkString($var, True);
        $this->field = $var;

return $this;
    }

/**
     * A description of why the request element is bad.
     *
     * Generated from protobuf field <code>string description = 2;</code>
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

/**
     * A description of why the request element is bad.
     *
     * Generated from protobuf field <code>string description = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setDescription($var)
    {
        GPBUtil::checkString($var, True);
        $this->description = $var;

return $this;
    }

}

Cancel / Back

[ MAINHACK ]

Viewing / Editing File: FieldViolation.php

Server Info

System Features

User Info