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

namespace Google\Cloud\AIPlatform\V1;

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

/**
 * Request message for
 * [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials].
 *
 * Generated from protobuf message <code>google.cloud.aiplatform.v1.SuggestTrialsRequest</code>
 */
class SuggestTrialsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The project and location that the Study belongs to.
     * Format: `projects/{project}/locations/{location}/studies/{study}`
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    private $parent = '';
    /**
     * Required. The number of suggestions requested. It must be positive.
     *
     * Generated from protobuf field <code>int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    private $suggestion_count = 0;
    /**
     * Required. The identifier of the client that is requesting the suggestion.
     * If multiple SuggestTrialsRequests have the same `client_id`,
     * the service will return the identical suggested Trial if the Trial is
     * pending, and provide a new Trial if the last suggested Trial was completed.
     *
     * Generated from protobuf field <code>string client_id = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    private $client_id = '';

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           Required. The project and location that the Study belongs to.
     *           Format: `projects/{project}/locations/{location}/studies/{study}`
     *     @type int $suggestion_count
     *           Required. The number of suggestions requested. It must be positive.
     *     @type string $client_id
     *           Required. The identifier of the client that is requesting the suggestion.
     *           If multiple SuggestTrialsRequests have the same `client_id`,
     *           the service will return the identical suggested Trial if the Trial is
     *           pending, and provide a new Trial if the last suggested Trial was completed.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Aiplatform\V1\VizierService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The project and location that the Study belongs to.
     * Format: `projects/{project}/locations/{location}/studies/{study}`
     *
     * 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 project and location that the Study belongs to.
     * Format: `projects/{project}/locations/{location}/studies/{study}`
     *
     * 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;
    }

    /**
     * Required. The number of suggestions requested. It must be positive.
     *
     * Generated from protobuf field <code>int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return int
     */
    public function getSuggestionCount()
    {
        return $this->suggestion_count;
    }

    /**
     * Required. The number of suggestions requested. It must be positive.
     *
     * Generated from protobuf field <code>int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param int $var
     * @return $this
     */
    public function setSuggestionCount($var)
    {
        GPBUtil::checkInt32($var);
        $this->suggestion_count = $var;

        return $this;
    }

    /**
     * Required. The identifier of the client that is requesting the suggestion.
     * If multiple SuggestTrialsRequests have the same `client_id`,
     * the service will return the identical suggested Trial if the Trial is
     * pending, and provide a new Trial if the last suggested Trial was completed.
     *
     * Generated from protobuf field <code>string client_id = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return string
     */
    public function getClientId()
    {
        return $this->client_id;
    }

    /**
     * Required. The identifier of the client that is requesting the suggestion.
     * If multiple SuggestTrialsRequests have the same `client_id`,
     * the service will return the identical suggested Trial if the Trial is
     * pending, and provide a new Trial if the last suggested Trial was completed.
     *
     * Generated from protobuf field <code>string client_id = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param string $var
     * @return $this
     */
    public function setClientId($var)
    {
        GPBUtil::checkString($var, True);
        $this->client_id = $var;

        return $this;
    }

}

