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

namespace Google\Cloud\Chronicle\V1;

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

/**
 * Request message for ListRuleDeployments.
 *
 * Generated from protobuf message <code>google.cloud.chronicle.v1.ListRuleDeploymentsRequest</code>
 */
class ListRuleDeploymentsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The collection of all parents which own all rule deployments. The
     * "-" wildcard token must be used as the rule identifier in the resource
     * path. Format:
     * `projects/{project}/locations/{location}/instances/{instance}/rules/-`
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * The maximum number of rule deployments to return. The service may return
     * fewer than this value. If unspecified, at most 100 rule deployments will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     */
    protected $page_size = 0;
    /**
     * A page token, received from a previous `ListRuleDeployments` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListRuleDeployments`
     * must match the call that provided the page token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     */
    protected $page_token = '';
    /**
     * A filter that can be used to retrieve specific rule deployments.
     * The following fields are filterable:
     * archived, name
     *
     * Generated from protobuf field <code>string filter = 4;</code>
     */
    protected $filter = '';

    /**
     * @param string $parent Required. The collection of all parents which own all rule deployments. The
     *                       "-" wildcard token must be used as the rule identifier in the resource
     *                       path. Format:
     *                       `projects/{project}/locations/{location}/instances/{instance}/rules/-`
     *                       Please see {@see RuleServiceClient::ruleName()} for help formatting this field.
     *
     * @return \Google\Cloud\Chronicle\V1\ListRuleDeploymentsRequest
     *
     * @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 collection of all parents which own all rule deployments. The
     *           "-" wildcard token must be used as the rule identifier in the resource
     *           path. Format:
     *           `projects/{project}/locations/{location}/instances/{instance}/rules/-`
     *     @type int $page_size
     *           The maximum number of rule deployments to return. The service may return
     *           fewer than this value. If unspecified, at most 100 rule deployments will be
     *           returned. The maximum value is 1000; values above 1000 will be coerced to
     *           1000.
     *     @type string $page_token
     *           A page token, received from a previous `ListRuleDeployments` call.
     *           Provide this to retrieve the subsequent page.
     *           When paginating, all other parameters provided to `ListRuleDeployments`
     *           must match the call that provided the page token.
     *     @type string $filter
     *           A filter that can be used to retrieve specific rule deployments.
     *           The following fields are filterable:
     *           archived, name
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Chronicle\V1\Rule::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The collection of all parents which own all rule deployments. The
     * "-" wildcard token must be used as the rule identifier in the resource
     * path. Format:
     * `projects/{project}/locations/{location}/instances/{instance}/rules/-`
     *
     * 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 collection of all parents which own all rule deployments. The
     * "-" wildcard token must be used as the rule identifier in the resource
     * path. Format:
     * `projects/{project}/locations/{location}/instances/{instance}/rules/-`
     *
     * 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;
    }

    /**
     * The maximum number of rule deployments to return. The service may return
     * fewer than this value. If unspecified, at most 100 rule deployments will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * The maximum number of rule deployments to return. The service may return
     * fewer than this value. If unspecified, at most 100 rule deployments will be
     * returned. The maximum value is 1000; values above 1000 will be coerced to
     * 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * A page token, received from a previous `ListRuleDeployments` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListRuleDeployments`
     * must match the call that provided the page token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * A page token, received from a previous `ListRuleDeployments` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListRuleDeployments`
     * must match the call that provided the page token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

    /**
     * A filter that can be used to retrieve specific rule deployments.
     * The following fields are filterable:
     * archived, name
     *
     * Generated from protobuf field <code>string filter = 4;</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * A filter that can be used to retrieve specific rule deployments.
     * The following fields are filterable:
     * archived, name
     *
     * Generated from protobuf field <code>string filter = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

}

