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

namespace Google\Cloud\Chronicle\V1;

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

/**
 * Request message for listing watchlists.
 *
 * Generated from protobuf message <code>google.cloud.chronicle.v1.ListWatchlistsRequest</code>
 */
class ListWatchlistsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The parent, which owns this collection of watchlists.
     * Format: `projects/{project}/locations/{location}/instances/{instance}`
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * Optional. The maximum number of watchlists to return.
     * The service may return fewer than this value.
     * If unspecified, at most 200 watchlists will be returned.
     * The maximum value is 200; values above 200 will be coerced to 200.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * Optional. A page token, received from a previous `ListWatchlists` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to
     * `ListWatchlists` must match the call that provided the page
     * token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';
    /**
     * Optional. Which watchlist to return in aip.dev/160 form.
     * Currently, only the following filters are supported:
     * - `watchlist_user_preferences.pinned=true`
     * - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])`
     * - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])`
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';

    /**
     * @param string $parent Required. The parent, which owns this collection of watchlists.
     *                       Format: `projects/{project}/locations/{location}/instances/{instance}`
     *                       Please see {@see EntityServiceClient::instanceName()} for help formatting this field.
     *
     * @return \Google\Cloud\Chronicle\V1\ListWatchlistsRequest
     *
     * @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, which owns this collection of watchlists.
     *           Format: `projects/{project}/locations/{location}/instances/{instance}`
     *     @type int $page_size
     *           Optional. The maximum number of watchlists to return.
     *           The service may return fewer than this value.
     *           If unspecified, at most 200 watchlists will be returned.
     *           The maximum value is 200; values above 200 will be coerced to 200.
     *     @type string $page_token
     *           Optional. A page token, received from a previous `ListWatchlists` call.
     *           Provide this to retrieve the subsequent page.
     *           When paginating, all other parameters provided to
     *           `ListWatchlists` must match the call that provided the page
     *           token.
     *     @type string $filter
     *           Optional. Which watchlist to return in aip.dev/160 form.
     *           Currently, only the following filters are supported:
     *           - `watchlist_user_preferences.pinned=true`
     *           - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])`
     *           - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])`
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Chronicle\V1\Entity::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The parent, which owns this collection of watchlists.
     * Format: `projects/{project}/locations/{location}/instances/{instance}`
     *
     * 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, which owns this collection of watchlists.
     * Format: `projects/{project}/locations/{location}/instances/{instance}`
     *
     * 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 watchlists to return.
     * The service may return fewer than this value.
     * If unspecified, at most 200 watchlists will be returned.
     * The maximum value is 200; values above 200 will be coerced to 200.
     *
     * 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 watchlists to return.
     * The service may return fewer than this value.
     * If unspecified, at most 200 watchlists will be returned.
     * The maximum value is 200; values above 200 will be coerced to 200.
     *
     * 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. A page token, received from a previous `ListWatchlists` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to
     * `ListWatchlists` must match the call that provided the page
     * token.
     *
     * 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. A page token, received from a previous `ListWatchlists` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to
     * `ListWatchlists` must match the call that provided the page
     * token.
     *
     * 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;
    }

    /**
     * Optional. Which watchlist to return in aip.dev/160 form.
     * Currently, only the following filters are supported:
     * - `watchlist_user_preferences.pinned=true`
     * - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])`
     * - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])`
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. Which watchlist to return in aip.dev/160 form.
     * Currently, only the following filters are supported:
     * - `watchlist_user_preferences.pinned=true`
     * - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])`
     * - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])`
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

}

