<?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 creating a BacktestResult resource.
 *
 * Generated from protobuf message <code>google.cloud.financialservices.v1.CreateBacktestResultRequest</code>
 */
class CreateBacktestResultRequest 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 = '';
    /**
     * Required. The resource id of the BacktestResult
     *
     * Generated from protobuf field <code>string backtest_result_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $backtest_result_id = '';
    /**
     * Required. The BacktestResult that will be created.
     *
     * Generated from protobuf field <code>.google.cloud.financialservices.v1.BacktestResult backtest_result = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $backtest_result = null;
    /**
     * Optional. An optional request ID to identify requests. Specify a unique
     * request ID so that if you must retry your request, the server will know to
     * ignore the request if it has already been completed. The server will
     * guarantee that for at least 60 minutes since the first request.
     * For example, consider a situation where you make an initial request and the
     * request times out. If you make the request again with the same request
     * ID, the server can check if original operation with the same request ID
     * was received, and if so, will ignore the second request. This prevents
     * clients from accidentally creating duplicate commitments.
     * The request ID must be a valid UUID with the exception that zero UUID is
     * not supported (00000000-0000-0000-0000-000000000000).
     *
     * Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $request_id = '';

    /**
     * @param string                                            $parent           Required. The parent of the BacktestResult is the Instance. Please see
     *                                                                            {@see AMLClient::instanceName()} for help formatting this field.
     * @param \Google\Cloud\FinancialServices\V1\BacktestResult $backtestResult   Required. The BacktestResult that will be created.
     * @param string                                            $backtestResultId Required. The resource id of the BacktestResult
     *
     * @return \Google\Cloud\FinancialServices\V1\CreateBacktestResultRequest
     *
     * @experimental
     */
    public static function build(string $parent, \Google\Cloud\FinancialServices\V1\BacktestResult $backtestResult, string $backtestResultId): self
    {
        return (new self())
            ->setParent($parent)
            ->setBacktestResult($backtestResult)
            ->setBacktestResultId($backtestResultId);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           Required. The parent of the BacktestResult is the Instance.
     *     @type string $backtest_result_id
     *           Required. The resource id of the BacktestResult
     *     @type \Google\Cloud\FinancialServices\V1\BacktestResult $backtest_result
     *           Required. The BacktestResult that will be created.
     *     @type string $request_id
     *           Optional. An optional request ID to identify requests. Specify a unique
     *           request ID so that if you must retry your request, the server will know to
     *           ignore the request if it has already been completed. The server will
     *           guarantee that for at least 60 minutes since the first request.
     *           For example, consider a situation where you make an initial request and the
     *           request times out. If you make the request again with the same request
     *           ID, the server can check if original operation with the same request ID
     *           was received, and if so, will ignore the second request. This prevents
     *           clients from accidentally creating duplicate commitments.
     *           The request ID must be a valid UUID with the exception that zero UUID is
     *           not supported (00000000-0000-0000-0000-000000000000).
     * }
     */
    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;
    }

    /**
     * Required. The resource id of the BacktestResult
     *
     * Generated from protobuf field <code>string backtest_result_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return string
     */
    public function getBacktestResultId()
    {
        return $this->backtest_result_id;
    }

    /**
     * Required. The resource id of the BacktestResult
     *
     * Generated from protobuf field <code>string backtest_result_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param string $var
     * @return $this
     */
    public function setBacktestResultId($var)
    {
        GPBUtil::checkString($var, True);
        $this->backtest_result_id = $var;

        return $this;
    }

    /**
     * Required. The BacktestResult that will be created.
     *
     * Generated from protobuf field <code>.google.cloud.financialservices.v1.BacktestResult backtest_result = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Cloud\FinancialServices\V1\BacktestResult|null
     */
    public function getBacktestResult()
    {
        return $this->backtest_result;
    }

    public function hasBacktestResult()
    {
        return isset($this->backtest_result);
    }

    public function clearBacktestResult()
    {
        unset($this->backtest_result);
    }

    /**
     * Required. The BacktestResult that will be created.
     *
     * Generated from protobuf field <code>.google.cloud.financialservices.v1.BacktestResult backtest_result = 3 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Cloud\FinancialServices\V1\BacktestResult $var
     * @return $this
     */
    public function setBacktestResult($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\FinancialServices\V1\BacktestResult::class);
        $this->backtest_result = $var;

        return $this;
    }

    /**
     * Optional. An optional request ID to identify requests. Specify a unique
     * request ID so that if you must retry your request, the server will know to
     * ignore the request if it has already been completed. The server will
     * guarantee that for at least 60 minutes since the first request.
     * For example, consider a situation where you make an initial request and the
     * request times out. If you make the request again with the same request
     * ID, the server can check if original operation with the same request ID
     * was received, and if so, will ignore the second request. This prevents
     * clients from accidentally creating duplicate commitments.
     * The request ID must be a valid UUID with the exception that zero UUID is
     * not supported (00000000-0000-0000-0000-000000000000).
     *
     * Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getRequestId()
    {
        return $this->request_id;
    }

    /**
     * Optional. An optional request ID to identify requests. Specify a unique
     * request ID so that if you must retry your request, the server will know to
     * ignore the request if it has already been completed. The server will
     * guarantee that for at least 60 minutes since the first request.
     * For example, consider a situation where you make an initial request and the
     * request times out. If you make the request again with the same request
     * ID, the server can check if original operation with the same request ID
     * was received, and if so, will ignore the second request. This prevents
     * clients from accidentally creating duplicate commitments.
     * The request ID must be a valid UUID with the exception that zero UUID is
     * not supported (00000000-0000-0000-0000-000000000000).
     *
     * Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setRequestId($var)
    {
        GPBUtil::checkString($var, True);
        $this->request_id = $var;

        return $this;
    }

}

