Package com.google.cloud.batch.v1

Interface AllocationPolicy.DiskOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      AllocationPolicy.Disk.DataSourceCase getDataSourceCase()  
      String getDiskInterface()
      Local SSDs are available through both "SCSI" and "NVMe" interfaces.
      com.google.protobuf.ByteString getDiskInterfaceBytes()
      Local SSDs are available through both "SCSI" and "NVMe" interfaces.
      String getImage()
      URL for a VM image to use as the data source for this disk.
      com.google.protobuf.ByteString getImageBytes()
      URL for a VM image to use as the data source for this disk.
      long getSizeGb()
      Disk size in GB.
      String getSnapshot()
      Name of a snapshot used as the data source.
      com.google.protobuf.ByteString getSnapshotBytes()
      Name of a snapshot used as the data source.
      String getType()
      Disk type as shown in `gcloud compute disk-types list`.
      com.google.protobuf.ByteString getTypeBytes()
      Disk type as shown in `gcloud compute disk-types list`.
      boolean hasImage()
      URL for a VM image to use as the data source for this disk.
      boolean hasSnapshot()
      Name of a snapshot used as the data source.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasImage

        boolean hasImage()
         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.
        string image = 4;
        Returns:
        Whether the image field is set.

      • getImage

        String getImage()
         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.
        string image = 4;
        Returns:
        The image.

      • getImageBytes

        com.google.protobuf.ByteString getImageBytes()
         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.
        string image = 4;
        Returns:
        The bytes for image.

      • hasSnapshot

        boolean hasSnapshot()
         Name of a snapshot used as the data source.
 Snapshot is not supported as boot disk now.
        string snapshot = 5;
        Returns:
        Whether the snapshot field is set.

      • getSnapshot

        String getSnapshot()
         Name of a snapshot used as the data source.
 Snapshot is not supported as boot disk now.
        string snapshot = 5;
        Returns:
        The snapshot.

      • getSnapshotBytes

        com.google.protobuf.ByteString getSnapshotBytes()
         Name of a snapshot used as the data source.
 Snapshot is not supported as boot disk now.
        string snapshot = 5;
        Returns:
        The bytes for snapshot.

      • getType

        String getType()
         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".
        string type = 1;
        Returns:
        The type.

      • getTypeBytes

        com.google.protobuf.ByteString getTypeBytes()
         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".
        string type = 1;
        Returns:
        The bytes for type.

      • getSizeGb

        long getSizeGb()
         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.
        int64 size_gb = 2;
        Returns:
        The sizeGb.

      • getDiskInterface

        String getDiskInterface()
         Local SSDs are available through both "SCSI" and "NVMe" interfaces.
 If not indicated, "NVMe" will be the default one for local ssds.
 We only support "SCSI" for persistent disks now.
        string disk_interface = 6;
        Returns:
        The diskInterface.

      • getDiskInterfaceBytes

        com.google.protobuf.ByteString getDiskInterfaceBytes()
         Local SSDs are available through both "SCSI" and "NVMe" interfaces.
 If not indicated, "NVMe" will be the default one for local ssds.
 We only support "SCSI" for persistent disks now.
        string disk_interface = 6;
        Returns:
        The bytes for diskInterface.