<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/aiplatform/v1/tensorboard_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
 * [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment].
 *
 * Generated from protobuf message <code>google.cloud.aiplatform.v1.UpdateTensorboardExperimentRequest</code>
 */
class UpdateTensorboardExperimentRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. Field mask is used to specify the fields to be overwritten in the
     * TensorboardExperiment resource by the update.
     * The fields specified in the update_mask are relative to the resource, not
     * the full request. A field is overwritten if it's in the mask. If the
     * user does not provide a mask then all fields are overwritten if new
     * values are specified.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $update_mask = null;
    /**
     * Required. The TensorboardExperiment's `name` field is used to identify the
     * TensorboardExperiment to be updated. Format:
     * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
     *
     * Generated from protobuf field <code>.google.cloud.aiplatform.v1.TensorboardExperiment tensorboard_experiment = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     */
    protected $tensorboard_experiment = null;

    /**
     * @param \Google\Cloud\AIPlatform\V1\TensorboardExperiment $tensorboardExperiment Required. The TensorboardExperiment's `name` field is used to identify the
     *                                                                                 TensorboardExperiment to be updated. Format:
     *                                                                                 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
     * @param \Google\Protobuf\FieldMask                        $updateMask            Required. Field mask is used to specify the fields to be overwritten in the
     *                                                                                 TensorboardExperiment resource by the update.
     *                                                                                 The fields specified in the update_mask are relative to the resource, not
     *                                                                                 the full request. A field is overwritten if it's in the mask. If the
     *                                                                                 user does not provide a mask then all fields are overwritten if new
     *                                                                                 values are specified.
     *
     * @return \Google\Cloud\AIPlatform\V1\UpdateTensorboardExperimentRequest
     *
     * @experimental
     */
    public static function build(\Google\Cloud\AIPlatform\V1\TensorboardExperiment $tensorboardExperiment, \Google\Protobuf\FieldMask $updateMask): self
    {
        return (new self())
            ->setTensorboardExperiment($tensorboardExperiment)
            ->setUpdateMask($updateMask);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Google\Protobuf\FieldMask $update_mask
     *           Required. Field mask is used to specify the fields to be overwritten in the
     *           TensorboardExperiment resource by the update.
     *           The fields specified in the update_mask are relative to the resource, not
     *           the full request. A field is overwritten if it's in the mask. If the
     *           user does not provide a mask then all fields are overwritten if new
     *           values are specified.
     *     @type \Google\Cloud\AIPlatform\V1\TensorboardExperiment $tensorboard_experiment
     *           Required. The TensorboardExperiment's `name` field is used to identify the
     *           TensorboardExperiment to be updated. Format:
     *           `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Aiplatform\V1\TensorboardService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. Field mask is used to specify the fields to be overwritten in the
     * TensorboardExperiment resource by the update.
     * The fields specified in the update_mask are relative to the resource, not
     * the full request. A field is overwritten if it's in the mask. If the
     * user does not provide a mask then all fields are overwritten if new
     * values are specified.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Protobuf\FieldMask|null
     */
    public function getUpdateMask()
    {
        return $this->update_mask;
    }

    public function hasUpdateMask()
    {
        return isset($this->update_mask);
    }

    public function clearUpdateMask()
    {
        unset($this->update_mask);
    }

    /**
     * Required. Field mask is used to specify the fields to be overwritten in the
     * TensorboardExperiment resource by the update.
     * The fields specified in the update_mask are relative to the resource, not
     * the full request. A field is overwritten if it's in the mask. If the
     * user does not provide a mask then all fields are overwritten if new
     * values are specified.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Protobuf\FieldMask $var
     * @return $this
     */
    public function setUpdateMask($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class);
        $this->update_mask = $var;

        return $this;
    }

    /**
     * Required. The TensorboardExperiment's `name` field is used to identify the
     * TensorboardExperiment to be updated. Format:
     * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
     *
     * Generated from protobuf field <code>.google.cloud.aiplatform.v1.TensorboardExperiment tensorboard_experiment = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @return \Google\Cloud\AIPlatform\V1\TensorboardExperiment|null
     */
    public function getTensorboardExperiment()
    {
        return $this->tensorboard_experiment;
    }

    public function hasTensorboardExperiment()
    {
        return isset($this->tensorboard_experiment);
    }

    public function clearTensorboardExperiment()
    {
        unset($this->tensorboard_experiment);
    }

    /**
     * Required. The TensorboardExperiment's `name` field is used to identify the
     * TensorboardExperiment to be updated. Format:
     * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
     *
     * Generated from protobuf field <code>.google.cloud.aiplatform.v1.TensorboardExperiment tensorboard_experiment = 2 [(.google.api.field_behavior) = REQUIRED];</code>
     * @param \Google\Cloud\AIPlatform\V1\TensorboardExperiment $var
     * @return $this
     */
    public function setTensorboardExperiment($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\TensorboardExperiment::class);
        $this->tensorboard_experiment = $var;

        return $this;
    }

}

