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

namespace Google\Cloud\RecaptchaEnterprise\V1;

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

/**
 * The ListIpOverrides request message.
 *
 * Generated from protobuf message <code>google.cloud.recaptchaenterprise.v1.ListIpOverridesRequest</code>
 */
class ListIpOverridesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The parent key for which the IP overrides are listed, in the
     * format `projects/{project}/keys/{key}`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    private $parent = '';
    /**
     * Optional. The maximum number of overrides to return. Default is 10. Max
     * limit is 100. If the number of overrides is less than the page_size, all
     * overrides are returned. If the page size is more than 100, it is coerced to
     * 100.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $page_size = 0;
    /**
     * Optional. The next_page_token value returned from a previous
     * ListIpOverridesRequest, if any.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $page_token = '';

    /**
     * @param string $parent Required. The parent key for which the IP overrides are listed, in the
     *                       format `projects/{project}/keys/{key}`. Please see
     *                       {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field.
     *
     * @return \Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest
     *
     * @experimental
     */
    public static function build(string $parent): self
    {
        return (new self())
            ->setParent($parent);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           Required. The parent key for which the IP overrides are listed, in the
     *           format `projects/{project}/keys/{key}`.
     *     @type int $page_size
     *           Optional. The maximum number of overrides to return. Default is 10. Max
     *           limit is 100. If the number of overrides is less than the page_size, all
     *           overrides are returned. If the page size is more than 100, it is coerced to
     *           100.
     *     @type string $page_token
     *           Optional. The next_page_token value returned from a previous
     *           ListIpOverridesRequest, if any.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Recaptchaenterprise\V1\Recaptchaenterprise::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The parent key for which the IP overrides are listed, in the
     * format `projects/{project}/keys/{key}`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Required. The parent key for which the IP overrides are listed, in the
     * format `projects/{project}/keys/{key}`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setParent($var)
    {
        GPBUtil::checkString($var, True);
        $this->parent = $var;

        return $this;
    }

    /**
     * Optional. The maximum number of overrides to return. Default is 10. Max
     * limit is 100. If the number of overrides is less than the page_size, all
     * overrides are returned. If the page size is more than 100, it is coerced to
     * 100.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * Optional. The maximum number of overrides to return. Default is 10. Max
     * limit is 100. If the number of overrides is less than the page_size, all
     * overrides are returned. If the page size is more than 100, it is coerced to
     * 100.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * Optional. The next_page_token value returned from a previous
     * ListIpOverridesRequest, if any.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * Optional. The next_page_token value returned from a previous
     * ListIpOverridesRequest, if any.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

}

