All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.compute.model.Disk.html Maven / Gradle / Ivy







Disk (Compute Engine API v1-rev20200104-1.30.8)












com.google.api.services.compute.model

Class Disk

  • All Implemented Interfaces:
    Cloneable, Map<String,Object>


    public final class Disk
    extends GenericJson
    Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Global](/compute/docs/reference/rest/latest/disks) * [Regional](/compute/docs/reference/rest/latest/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==)

    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 Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

    Author:
    Google, Inc.
    • Constructor Detail

      • Disk

        public Disk()
    • Method Detail

      • getCreationTimestamp

        public String getCreationTimestamp()
        [Output Only] Creation timestamp in RFC3339 text format.
        Returns:
        value or null for none
      • setCreationTimestamp

        public Disk setCreationTimestamp(String creationTimestamp)
        [Output Only] Creation timestamp in RFC3339 text format.
        Parameters:
        creationTimestamp - creationTimestamp or null for none
      • getDescription

        public String getDescription()
        An optional description of this resource. Provide this property when you create the resource.
        Returns:
        value or null for none
      • setDescription

        public Disk setDescription(String description)
        An optional description of this resource. Provide this property when you create the resource.
        Parameters:
        description - description or null for none
      • getDiskEncryptionKey

        public CustomerEncryptionKey getDiskEncryptionKey()
        Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
        Returns:
        value or null for none
      • setDiskEncryptionKey

        public Disk setDiskEncryptionKey(CustomerEncryptionKey diskEncryptionKey)
        Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
        Parameters:
        diskEncryptionKey - diskEncryptionKey or null for none
      • getGuestOsFeatures

        public List<GuestOsFeature> getGuestOsFeatures()
        A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
        Returns:
        value or null for none
      • setGuestOsFeatures

        public Disk setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)
        A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
        Parameters:
        guestOsFeatures - guestOsFeatures or null for none
      • getId

        public BigInteger getId()
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        Returns:
        value or null for none
      • setId

        public Disk setId(BigInteger id)
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        Parameters:
        id - id or null for none
      • getKind

        public String getKind()
        [Output Only] Type of the resource. Always compute#disk for disks.
        Returns:
        value or null for none
      • setKind

        public Disk setKind(String kind)
        [Output Only] Type of the resource. Always compute#disk for disks.
        Parameters:
        kind - kind or null for none
      • getLabelFingerprint

        public String getLabelFingerprint()
        A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
        Returns:
        value or null for none
        See Also:
        decodeLabelFingerprint()
      • decodeLabelFingerprint

        public byte[] decodeLabelFingerprint()
        A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
        Returns:
        Base64 decoded value or null for none
        Since:
        1.14
        See Also:
        getLabelFingerprint()
      • setLabelFingerprint

        public Disk setLabelFingerprint(String labelFingerprint)
        A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
        Parameters:
        labelFingerprint - labelFingerprint or null for none
        See Also:
        #encodeLabelFingerprint()
      • encodeLabelFingerprint

        public Disk encodeLabelFingerprint(byte[] labelFingerprint)
        A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
        Since:
        1.14
        See Also:

        The value is encoded Base64 or {@code null} for none.

      • getLabels

        public Map<String,String> getLabels()
        Labels to apply to this disk. These can be later modified by the setLabels method.
        Returns:
        value or null for none
      • setLabels

        public Disk setLabels(Map<String,String> labels)
        Labels to apply to this disk. These can be later modified by the setLabels method.
        Parameters:
        labels - labels or null for none
      • getLastAttachTimestamp

        public String getLastAttachTimestamp()
        [Output Only] Last attach timestamp in RFC3339 text format.
        Returns:
        value or null for none
      • setLastAttachTimestamp

        public Disk setLastAttachTimestamp(String lastAttachTimestamp)
        [Output Only] Last attach timestamp in RFC3339 text format.
        Parameters:
        lastAttachTimestamp - lastAttachTimestamp or null for none
      • getLastDetachTimestamp

        public String getLastDetachTimestamp()
        [Output Only] Last detach timestamp in RFC3339 text format.
        Returns:
        value or null for none
      • setLastDetachTimestamp

        public Disk setLastDetachTimestamp(String lastDetachTimestamp)
        [Output Only] Last detach timestamp in RFC3339 text format.
        Parameters:
        lastDetachTimestamp - lastDetachTimestamp or null for none
      • getLicenseCodes

        public List<Long> getLicenseCodes()
        Integer license codes indicating which licenses are attached to this disk.
        Returns:
        value or null for none
      • setLicenseCodes

        public Disk setLicenseCodes(List<Long> licenseCodes)
        Integer license codes indicating which licenses are attached to this disk.
        Parameters:
        licenseCodes - licenseCodes or null for none
      • getLicenses

        public List<String> getLicenses()
        A list of publicly visible licenses. Reserved for Google's use.
        Returns:
        value or null for none
      • setLicenses

        public Disk setLicenses(List<String> licenses)
        A list of publicly visible licenses. Reserved for Google's use.
        Parameters:
        licenses - licenses or null for none
      • getName

        public String getName()
        Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        Returns:
        value or null for none
      • setName

        public Disk setName(String name)
        Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        Parameters:
        name - name or null for none
      • getOptions

        public String getOptions()
        Internal use only.
        Returns:
        value or null for none
      • setOptions

        public Disk setOptions(String options)
        Internal use only.
        Parameters:
        options - options or null for none
      • getPhysicalBlockSizeBytes

        public Long getPhysicalBlockSizeBytes()
        Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
        Returns:
        value or null for none
      • setPhysicalBlockSizeBytes

        public Disk setPhysicalBlockSizeBytes(Long physicalBlockSizeBytes)
        Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
        Parameters:
        physicalBlockSizeBytes - physicalBlockSizeBytes or null for none
      • getRegion

        public String getRegion()
        [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        Returns:
        value or null for none
      • setRegion

        public Disk setRegion(String region)
        [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        Parameters:
        region - region or null for none
      • getReplicaZones

        public List<String> getReplicaZones()
        URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
        Returns:
        value or null for none
      • setReplicaZones

        public Disk setReplicaZones(List<String> replicaZones)
        URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
        Parameters:
        replicaZones - replicaZones or null for none
      • getResourcePolicies

        public List<String> getResourcePolicies()
        Resource policies applied to this disk for automatic snapshot creations.
        Returns:
        value or null for none
      • setResourcePolicies

        public Disk setResourcePolicies(List<String> resourcePolicies)
        Resource policies applied to this disk for automatic snapshot creations.
        Parameters:
        resourcePolicies - resourcePolicies or null for none
      • getSelfLink

        public String getSelfLink()
        [Output Only] Server-defined fully-qualified URL for this resource.
        Returns:
        value or null for none
      • setSelfLink

        public Disk setSelfLink(String selfLink)
        [Output Only] Server-defined fully-qualified URL for this resource.
        Parameters:
        selfLink - selfLink or null for none
      • getSizeGb

        public Long getSizeGb()
        Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.
        Returns:
        value or null for none
      • setSizeGb

        public Disk setSizeGb(Long sizeGb)
        Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.
        Parameters:
        sizeGb - sizeGb or null for none
      • getSourceImage

        public String getSourceImage()
        The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects /debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian- cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family /my-image-family
        Returns:
        value or null for none
      • setSourceImage

        public Disk setSourceImage(String sourceImage)
        The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects /debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian- cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family /my-image-family
        Parameters:
        sourceImage - sourceImage or null for none
      • getSourceImageEncryptionKey

        public CustomerEncryptionKey getSourceImageEncryptionKey()
        The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        Returns:
        value or null for none
      • setSourceImageEncryptionKey

        public Disk setSourceImageEncryptionKey(CustomerEncryptionKey sourceImageEncryptionKey)
        The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
        Parameters:
        sourceImageEncryptionKey - sourceImageEncryptionKey or null for none
      • getSourceImageId

        public String getSourceImageId()
        [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
        Returns:
        value or null for none
      • setSourceImageId

        public Disk setSourceImageId(String sourceImageId)
        [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
        Parameters:
        sourceImageId - sourceImageId or null for none
      • getSourceSnapshot

        public String getSourceSnapshot()
        The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
        Returns:
        value or null for none
      • setSourceSnapshot

        public Disk setSourceSnapshot(String sourceSnapshot)
        The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
        Parameters:
        sourceSnapshot - sourceSnapshot or null for none
      • getSourceSnapshotEncryptionKey

        public CustomerEncryptionKey getSourceSnapshotEncryptionKey()
        The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
        Returns:
        value or null for none
      • setSourceSnapshotEncryptionKey

        public Disk setSourceSnapshotEncryptionKey(CustomerEncryptionKey sourceSnapshotEncryptionKey)
        The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
        Parameters:
        sourceSnapshotEncryptionKey - sourceSnapshotEncryptionKey or null for none
      • getSourceSnapshotId

        public String getSourceSnapshotId()
        [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
        Returns:
        value or null for none
      • setSourceSnapshotId

        public Disk setSourceSnapshotId(String sourceSnapshotId)
        [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
        Parameters:
        sourceSnapshotId - sourceSnapshotId or null for none
      • getStatus

        public String getStatus()
        [Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting.
        Returns:
        value or null for none
      • setStatus

        public Disk setStatus(String status)
        [Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting.
        Parameters:
        status - status or null for none
      • getType

        public String getType()
        URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
        Returns:
        value or null for none
      • setType

        public Disk setType(String type)
        URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
        Parameters:
        type - type or null for none
      • getUsers

        public List<String> getUsers()
        [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
        Returns:
        value or null for none
      • setUsers

        public Disk setUsers(List<String> users)
        [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
        Parameters:
        users - users or null for none
      • getZone

        public String getZone()
        [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        Returns:
        value or null for none
      • setZone

        public Disk setZone(String zone)
        [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
        Parameters:
        zone - zone or null for none

Copyright © 2011–2020 Google. All rights reserved.





© 2015 - 2025 Weber Informatics LLC | Privacy Policy