com.google.api.services.batch.v1.model.Disk Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.batch.v1.model;
/**
* 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.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Batch API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class Disk extends com.google.api.client.json.GenericJson {
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String diskInterface;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String image;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long sizeGb;
/**
* Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String snapshot;
/**
* 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".
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String type;
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getDiskInterface() {
return diskInterface;
}
/**
* 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.
* @param diskInterface diskInterface or {@code null} for none
*/
public Disk setDiskInterface(java.lang.String diskInterface) {
this.diskInterface = diskInterface;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getImage() {
return 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.
* @param image image or {@code null} for none
*/
public Disk setImage(java.lang.String image) {
this.image = image;
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.
* @return value or {@code null} for none
*/
public java.lang.Long getSizeGb() {
return sizeGb;
}
/**
* 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.
* @param sizeGb sizeGb or {@code null} for none
*/
public Disk setSizeGb(java.lang.Long sizeGb) {
this.sizeGb = sizeGb;
return this;
}
/**
* Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
* @return value or {@code null} for none
*/
public java.lang.String getSnapshot() {
return snapshot;
}
/**
* Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
* @param snapshot snapshot or {@code null} for none
*/
public Disk setSnapshot(java.lang.String snapshot) {
this.snapshot = snapshot;
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".
* @return value or {@code null} for none
*/
public java.lang.String getType() {
return 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".
* @param type type or {@code null} for none
*/
public Disk setType(java.lang.String type) {
this.type = type;
return this;
}
@Override
public Disk set(String fieldName, Object value) {
return (Disk) super.set(fieldName, value);
}
@Override
public Disk clone() {
return (Disk) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy