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

namespace Google\Cloud\Batch\V1\AllocationPolicy;

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

/**
 * A new persistent disk or a local ssd.
 * A VM can only have one local SSD setting but multiple local SSD partitions.
 * See https://cloud.google.com/compute/docs/disks#pdspecs and
 * https://cloud.google.com/compute/docs/disks#localssds.
 *
 * Generated from protobuf message <code>google.cloud.batch.v1.AllocationPolicy.Disk</code>
 */
class Disk extends \Google\Protobuf\Internal\Message
{
    /**
     * Disk type as shown in `gcloud compute disk-types list`.
     * For example, local SSD uses type "local-ssd".
     * Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd"
     * or "pd-standard". If not specified, "pd-standard" will be used as the
     * default type for non-boot disks, "pd-balanced" will be used as the
     * default type for boot disks.
     *
     * Generated from protobuf field <code>string type = 1;</code>
     */
    protected $type = '';
    /**
     * Disk size in GB.
     * **Non-Boot Disk**:
     * If the `type` specifies a persistent disk, this field
     * is ignored if `data_source` is set as `image` or `snapshot`.
     * If the `type` specifies a local SSD, this field should be a multiple of
     * 375 GB, otherwise, the final size will be the next greater multiple of
     * 375 GB.
     * **Boot Disk**:
     * Batch will calculate the boot disk size based on source
     * image and task requirements if you do not speicify the size.
     * If both this field and the `boot_disk_mib` field in task spec's
     * `compute_resource` are defined, Batch will only honor this field.
     * Also, this field should be no smaller than the source disk's
     * size when the `data_source` is set as `snapshot` or `image`.
     * For example, if you set an image as the `data_source` field and the
     * image's default disk size 30 GB, you can only use this field to make the
     * disk larger or equal to 30 GB.
     *
     * Generated from protobuf field <code>int64 size_gb = 2;</code>
     */
    protected $size_gb = 0;
    /**
     * Local SSDs are available through both "SCSI" and "NVMe" interfaces.
     * If not indicated, "NVMe" will be the default one for local ssds.
     * This field is ignored for persistent disks as the interface is chosen
     * automatically. See
     * https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
     *
     * Generated from protobuf field <code>string disk_interface = 6;</code>
     */
    protected $disk_interface = '';
    protected $data_source;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $image
     *           URL for a VM image to use as the data source for this disk.
     *           For example, the following are all valid URLs:
     *           * Specify the image by its family name:
     *           projects/{project}/global/images/family/{image_family}
     *           * Specify the image version:
     *           projects/{project}/global/images/{image_version}
     *           You can also use Batch customized image in short names.
     *           The following image values are supported for a boot disk:
     *           * `batch-debian`: use Batch Debian images.
     *           * `batch-centos`: use Batch CentOS images.
     *           * `batch-cos`: use Batch Container-Optimized images.
     *           * `batch-hpc-centos`: use Batch HPC CentOS images.
     *           * `batch-hpc-rocky`: use Batch HPC Rocky Linux images.
     *     @type string $snapshot
     *           Name of a snapshot used as the data source.
     *           Snapshot is not supported as boot disk now.
     *     @type string $type
     *           Disk type as shown in `gcloud compute disk-types list`.
     *           For example, local SSD uses type "local-ssd".
     *           Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd"
     *           or "pd-standard". If not specified, "pd-standard" will be used as the
     *           default type for non-boot disks, "pd-balanced" will be used as the
     *           default type for boot disks.
     *     @type int|string $size_gb
     *           Disk size in GB.
     *           **Non-Boot Disk**:
     *           If the `type` specifies a persistent disk, this field
     *           is ignored if `data_source` is set as `image` or `snapshot`.
     *           If the `type` specifies a local SSD, this field should be a multiple of
     *           375 GB, otherwise, the final size will be the next greater multiple of
     *           375 GB.
     *           **Boot Disk**:
     *           Batch will calculate the boot disk size based on source
     *           image and task requirements if you do not speicify the size.
     *           If both this field and the `boot_disk_mib` field in task spec's
     *           `compute_resource` are defined, Batch will only honor this field.
     *           Also, this field should be no smaller than the source disk's
     *           size when the `data_source` is set as `snapshot` or `image`.
     *           For example, if you set an image as the `data_source` field and the
     *           image's default disk size 30 GB, you can only use this field to make the
     *           disk larger or equal to 30 GB.
     *     @type string $disk_interface
     *           Local SSDs are available through both "SCSI" and "NVMe" interfaces.
     *           If not indicated, "NVMe" will be the default one for local ssds.
     *           This field is ignored for persistent disks as the interface is chosen
     *           automatically. See
     *           https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Batch\V1\Job::initOnce();
        parent::__construct($data);
    }

    /**
     * URL for a VM image to use as the data source for this disk.
     * For example, the following are all valid URLs:
     * * Specify the image by its family name:
     * projects/{project}/global/images/family/{image_family}
     * * Specify the image version:
     * projects/{project}/global/images/{image_version}
     * You can also use Batch customized image in short names.
     * The following image values are supported for a boot disk:
     * * `batch-debian`: use Batch Debian images.
     * * `batch-centos`: use Batch CentOS images.
     * * `batch-cos`: use Batch Container-Optimized images.
     * * `batch-hpc-centos`: use Batch HPC CentOS images.
     * * `batch-hpc-rocky`: use Batch HPC Rocky Linux images.
     *
     * Generated from protobuf field <code>string image = 4;</code>
     * @return string
     */
    public function getImage()
    {
        return $this->readOneof(4);
    }

    public function hasImage()
    {
        return $this->hasOneof(4);
    }

    /**
     * URL for a VM image to use as the data source for this disk.
     * For example, the following are all valid URLs:
     * * Specify the image by its family name:
     * projects/{project}/global/images/family/{image_family}
     * * Specify the image version:
     * projects/{project}/global/images/{image_version}
     * You can also use Batch customized image in short names.
     * The following image values are supported for a boot disk:
     * * `batch-debian`: use Batch Debian images.
     * * `batch-centos`: use Batch CentOS images.
     * * `batch-cos`: use Batch Container-Optimized images.
     * * `batch-hpc-centos`: use Batch HPC CentOS images.
     * * `batch-hpc-rocky`: use Batch HPC Rocky Linux images.
     *
     * Generated from protobuf field <code>string image = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setImage($var)
    {
        GPBUtil::checkString($var, True);
        $this->writeOneof(4, $var);

        return $this;
    }

    /**
     * Name of a snapshot used as the data source.
     * Snapshot is not supported as boot disk now.
     *
     * Generated from protobuf field <code>string snapshot = 5;</code>
     * @return string
     */
    public function getSnapshot()
    {
        return $this->readOneof(5);
    }

    public function hasSnapshot()
    {
        return $this->hasOneof(5);
    }

    /**
     * Name of a snapshot used as the data source.
     * Snapshot is not supported as boot disk now.
     *
     * Generated from protobuf field <code>string snapshot = 5;</code>
     * @param string $var
     * @return $this
     */
    public function setSnapshot($var)
    {
        GPBUtil::checkString($var, True);
        $this->writeOneof(5, $var);

        return $this;
    }

    /**
     * Disk type as shown in `gcloud compute disk-types list`.
     * For example, local SSD uses type "local-ssd".
     * Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd"
     * or "pd-standard". If not specified, "pd-standard" will be used as the
     * default type for non-boot disks, "pd-balanced" will be used as the
     * default type for boot disks.
     *
     * Generated from protobuf field <code>string type = 1;</code>
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Disk type as shown in `gcloud compute disk-types list`.
     * For example, local SSD uses type "local-ssd".
     * Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd"
     * or "pd-standard". If not specified, "pd-standard" will be used as the
     * default type for non-boot disks, "pd-balanced" will be used as the
     * default type for boot disks.
     *
     * Generated from protobuf field <code>string type = 1;</code>
     * @param string $var
     * @return $this
     */
    public function setType($var)
    {
        GPBUtil::checkString($var, True);
        $this->type = $var;

        return $this;
    }

    /**
     * Disk size in GB.
     * **Non-Boot Disk**:
     * If the `type` specifies a persistent disk, this field
     * is ignored if `data_source` is set as `image` or `snapshot`.
     * If the `type` specifies a local SSD, this field should be a multiple of
     * 375 GB, otherwise, the final size will be the next greater multiple of
     * 375 GB.
     * **Boot Disk**:
     * Batch will calculate the boot disk size based on source
     * image and task requirements if you do not speicify the size.
     * If both this field and the `boot_disk_mib` field in task spec's
     * `compute_resource` are defined, Batch will only honor this field.
     * Also, this field should be no smaller than the source disk's
     * size when the `data_source` is set as `snapshot` or `image`.
     * For example, if you set an image as the `data_source` field and the
     * image's default disk size 30 GB, you can only use this field to make the
     * disk larger or equal to 30 GB.
     *
     * Generated from protobuf field <code>int64 size_gb = 2;</code>
     * @return int|string
     */
    public function getSizeGb()
    {
        return $this->size_gb;
    }

    /**
     * Disk size in GB.
     * **Non-Boot Disk**:
     * If the `type` specifies a persistent disk, this field
     * is ignored if `data_source` is set as `image` or `snapshot`.
     * If the `type` specifies a local SSD, this field should be a multiple of
     * 375 GB, otherwise, the final size will be the next greater multiple of
     * 375 GB.
     * **Boot Disk**:
     * Batch will calculate the boot disk size based on source
     * image and task requirements if you do not speicify the size.
     * If both this field and the `boot_disk_mib` field in task spec's
     * `compute_resource` are defined, Batch will only honor this field.
     * Also, this field should be no smaller than the source disk's
     * size when the `data_source` is set as `snapshot` or `image`.
     * For example, if you set an image as the `data_source` field and the
     * image's default disk size 30 GB, you can only use this field to make the
     * disk larger or equal to 30 GB.
     *
     * Generated from protobuf field <code>int64 size_gb = 2;</code>
     * @param int|string $var
     * @return $this
     */
    public function setSizeGb($var)
    {
        GPBUtil::checkInt64($var);
        $this->size_gb = $var;

        return $this;
    }

    /**
     * Local SSDs are available through both "SCSI" and "NVMe" interfaces.
     * If not indicated, "NVMe" will be the default one for local ssds.
     * This field is ignored for persistent disks as the interface is chosen
     * automatically. See
     * https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
     *
     * Generated from protobuf field <code>string disk_interface = 6;</code>
     * @return string
     */
    public function getDiskInterface()
    {
        return $this->disk_interface;
    }

    /**
     * Local SSDs are available through both "SCSI" and "NVMe" interfaces.
     * If not indicated, "NVMe" will be the default one for local ssds.
     * This field is ignored for persistent disks as the interface is chosen
     * automatically. See
     * https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
     *
     * Generated from protobuf field <code>string disk_interface = 6;</code>
     * @param string $var
     * @return $this
     */
    public function setDiskInterface($var)
    {
        GPBUtil::checkString($var, True);
        $this->disk_interface = $var;

        return $this;
    }

    /**
     * @return string
     */
    public function getDataSource()
    {
        return $this->whichOneof("data_source");
    }

}


