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

namespace Grafeas\V1;

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

/**
 * Request to list occurrences.
 *
 * Generated from protobuf message <code>grafeas.v1.ListOccurrencesRequest</code>
 */
class ListOccurrencesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * The name of the project to list occurrences for in the form of
     * `projects/[PROJECT_ID]`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * The filter expression.
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     */
    protected $filter = '';
    /**
     * Number of occurrences to return in the list. Must be positive. Max allowed
     * page size is 1000. If not specified, page size defaults to 20.
     *
     * Generated from protobuf field <code>int32 page_size = 3;</code>
     */
    protected $page_size = 0;
    /**
     * Token to provide to skip to a particular spot in the list.
     *
     * Generated from protobuf field <code>string page_token = 4;</code>
     */
    protected $page_token = '';
    /**
     * If set, the request will return all reachable Occurrences
     * and report all unreachable regions in the `unreachable` field in
     * the response.
     * Only applicable for requests in the global region.
     *
     * Generated from protobuf field <code>bool return_partial_success = 5;</code>
     */
    protected $return_partial_success = false;

    /**
     * @param string $parent The name of the project to list occurrences for in the form of
     *                       `projects/[PROJECT_ID]`. Please see
     *                       {@see GrafeasClient::projectName()} for help formatting this field.
     * @param string $filter The filter expression.
     *
     * @return \Grafeas\V1\ListOccurrencesRequest
     *
     * @experimental
     */
    public static function build(string $parent, string $filter): self
    {
        return (new self())
            ->setParent($parent)
            ->setFilter($filter);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           The name of the project to list occurrences for in the form of
     *           `projects/[PROJECT_ID]`.
     *     @type string $filter
     *           The filter expression.
     *     @type int $page_size
     *           Number of occurrences to return in the list. Must be positive. Max allowed
     *           page size is 1000. If not specified, page size defaults to 20.
     *     @type string $page_token
     *           Token to provide to skip to a particular spot in the list.
     *     @type bool $return_partial_success
     *           If set, the request will return all reachable Occurrences
     *           and report all unreachable regions in the `unreachable` field in
     *           the response.
     *           Only applicable for requests in the global region.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Grafeas\V1\Grafeas::initOnce();
        parent::__construct($data);
    }

    /**
     * The name of the project to list occurrences for in the form of
     * `projects/[PROJECT_ID]`.
     *
     * 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;
    }

    /**
     * The name of the project to list occurrences for in the form of
     * `projects/[PROJECT_ID]`.
     *
     * 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 filter expression.
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * The filter expression.
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

    /**
     * Number of occurrences to return in the list. Must be positive. Max allowed
     * page size is 1000. If not specified, page size defaults to 20.
     *
     * Generated from protobuf field <code>int32 page_size = 3;</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * Number of occurrences to return in the list. Must be positive. Max allowed
     * page size is 1000. If not specified, page size defaults to 20.
     *
     * Generated from protobuf field <code>int32 page_size = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * Token to provide to skip to a particular spot in the list.
     *
     * Generated from protobuf field <code>string page_token = 4;</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * Token to provide to skip to a particular spot in the list.
     *
     * Generated from protobuf field <code>string page_token = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

    /**
     * If set, the request will return all reachable Occurrences
     * and report all unreachable regions in the `unreachable` field in
     * the response.
     * Only applicable for requests in the global region.
     *
     * Generated from protobuf field <code>bool return_partial_success = 5;</code>
     * @return bool
     */
    public function getReturnPartialSuccess()
    {
        return $this->return_partial_success;
    }

    /**
     * If set, the request will return all reachable Occurrences
     * and report all unreachable regions in the `unreachable` field in
     * the response.
     * Only applicable for requests in the global region.
     *
     * Generated from protobuf field <code>bool return_partial_success = 5;</code>
     * @param bool $var
     * @return $this
     */
    public function setReturnPartialSuccess($var)
    {
        GPBUtil::checkBool($var);
        $this->return_partial_success = $var;

        return $this;
    }

}

