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

namespace Google\Cloud\ContactCenterInsights\V1;

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

/**
 * Request to list QaScorecardRevisions
 *
 * Generated from protobuf message <code>google.cloud.contactcenterinsights.v1.ListQaScorecardRevisionsRequest</code>
 */
class ListQaScorecardRevisionsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The parent resource of the scorecard revisions. To list all
     * revisions of all scorecards, substitute the QaScorecard ID with a '-'
     * character.
     *
     * 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 scorecard revisions to return in the
     * response. If the value is zero, the service will select a default size. A
     * call might return fewer objects than requested. A non-empty
     * `next_page_token` in the response indicates that more data is available.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * Optional. The value returned by the last
     * `ListQaScorecardRevisionsResponse`. This value indicates that this is a
     * continuation of a prior `ListQaScorecardRevisions` call and that the system
     * should return the next page of data.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';
    /**
     * Optional. A filter to reduce results to a specific subset. Useful for
     * querying scorecard revisions with specific properties.
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';

    /**
     * @param string $parent Required. The parent resource of the scorecard revisions. To list all
     *                       revisions of all scorecards, substitute the QaScorecard ID with a '-'
     *                       character. Please see
     *                       {@see ContactCenterInsightsClient::qaScorecardName()} for help formatting this field.
     *
     * @return \Google\Cloud\ContactCenterInsights\V1\ListQaScorecardRevisionsRequest
     *
     * @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 resource of the scorecard revisions. To list all
     *           revisions of all scorecards, substitute the QaScorecard ID with a '-'
     *           character.
     *     @type int $page_size
     *           Optional. The maximum number of scorecard revisions to return in the
     *           response. If the value is zero, the service will select a default size. A
     *           call might return fewer objects than requested. A non-empty
     *           `next_page_token` in the response indicates that more data is available.
     *     @type string $page_token
     *           Optional. The value returned by the last
     *           `ListQaScorecardRevisionsResponse`. This value indicates that this is a
     *           continuation of a prior `ListQaScorecardRevisions` call and that the system
     *           should return the next page of data.
     *     @type string $filter
     *           Optional. A filter to reduce results to a specific subset. Useful for
     *           querying scorecard revisions with specific properties.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Contactcenterinsights\V1\ContactCenterInsights::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The parent resource of the scorecard revisions. To list all
     * revisions of all scorecards, substitute the QaScorecard ID with a '-'
     * character.
     *
     * 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 resource of the scorecard revisions. To list all
     * revisions of all scorecards, substitute the QaScorecard ID with a '-'
     * character.
     *
     * 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 scorecard revisions to return in the
     * response. If the value is zero, the service will select a default size. A
     * call might return fewer objects than requested. A non-empty
     * `next_page_token` in the response indicates that more data is available.
     *
     * 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 scorecard revisions to return in the
     * response. If the value is zero, the service will select a default size. A
     * call might return fewer objects than requested. A non-empty
     * `next_page_token` in the response indicates that more data is available.
     *
     * 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 value returned by the last
     * `ListQaScorecardRevisionsResponse`. This value indicates that this is a
     * continuation of a prior `ListQaScorecardRevisions` call and that the system
     * should return the next page of data.
     *
     * 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 value returned by the last
     * `ListQaScorecardRevisionsResponse`. This value indicates that this is a
     * continuation of a prior `ListQaScorecardRevisions` call and that the system
     * should return the next page of data.
     *
     * 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. A filter to reduce results to a specific subset. Useful for
     * querying scorecard revisions with specific properties.
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. A filter to reduce results to a specific subset. Useful for
     * querying scorecard revisions with specific properties.
     *
     * 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;
    }

}

