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

namespace Google\Cloud\FinancialServices\V1;

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

/**
 * Request for retrieving a paginated list of BacktestResult resources that
 * meet the specified criteria.
 *
 * Generated from protobuf message <code>google.cloud.financialservices.v1.ListBacktestResultsRequest</code>
 */
class ListBacktestResultsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The parent of the BacktestResult is the Instance.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * The number of resources to be included in the response. The response
     * contains a next_page_token, which can be used to retrieve the next page of
     * resources.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     */
    protected $page_size = 0;
    /**
     * In case of paginated results, this is the token that was returned in the
     * previous ListBacktestResultsResponse. It should be copied here to
     * retrieve the next page of resources. Empty will give the first page of
     * ListBacktestResultsRequest, and the last page will return an empty
     * page_token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     */
    protected $page_token = '';
    /**
     * Specify a filter to narrow search results.
     *
     * Generated from protobuf field <code>string filter = 4;</code>
     */
    protected $filter = '';
    /**
     * Specify a field to use for ordering.
     *
     * Generated from protobuf field <code>string order_by = 5;</code>
     */
    protected $order_by = '';

    /**
     * @param string $parent Required. The parent of the BacktestResult is the Instance. Please see
     *                       {@see AMLClient::instanceName()} for help formatting this field.
     *
     * @return \Google\Cloud\FinancialServices\V1\ListBacktestResultsRequest
     *
     * @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 of the BacktestResult is the Instance.
     *     @type int $page_size
     *           The number of resources to be included in the response. The response
     *           contains a next_page_token, which can be used to retrieve the next page of
     *           resources.
     *     @type string $page_token
     *           In case of paginated results, this is the token that was returned in the
     *           previous ListBacktestResultsResponse. It should be copied here to
     *           retrieve the next page of resources. Empty will give the first page of
     *           ListBacktestResultsRequest, and the last page will return an empty
     *           page_token.
     *     @type string $filter
     *           Specify a filter to narrow search results.
     *     @type string $order_by
     *           Specify a field to use for ordering.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Financialservices\V1\BacktestResult::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The parent of the BacktestResult is the 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 of the BacktestResult is the 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;
    }

    /**
     * The number of resources to be included in the response. The response
     * contains a next_page_token, which can be used to retrieve the next page of
     * resources.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * The number of resources to be included in the response. The response
     * contains a next_page_token, which can be used to retrieve the next page of
     * resources.
     *
     * 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;
    }

    /**
     * In case of paginated results, this is the token that was returned in the
     * previous ListBacktestResultsResponse. It should be copied here to
     * retrieve the next page of resources. Empty will give the first page of
     * ListBacktestResultsRequest, and the last page will return an empty
     * page_token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * In case of paginated results, this is the token that was returned in the
     * previous ListBacktestResultsResponse. It should be copied here to
     * retrieve the next page of resources. Empty will give the first page of
     * ListBacktestResultsRequest, and the last page will return an empty
     * 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;
    }

    /**
     * Specify a filter to narrow search results.
     *
     * Generated from protobuf field <code>string filter = 4;</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Specify a filter to narrow search results.
     *
     * 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;
    }

    /**
     * Specify a field to use for ordering.
     *
     * Generated from protobuf field <code>string order_by = 5;</code>
     * @return string
     */
    public function getOrderBy()
    {
        return $this->order_by;
    }

    /**
     * Specify a field to use for ordering.
     *
     * Generated from protobuf field <code>string order_by = 5;</code>
     * @param string $var
     * @return $this
     */
    public function setOrderBy($var)
    {
        GPBUtil::checkString($var, True);
        $this->order_by = $var;

        return $this;
    }

}

