Package com.azure.resourcemanager.compute.fluent.models

Class SnapshotProperties

  • public final class SnapshotProperties
extends Object
    Snapshot resource properties.

    • Constructor Detail

      • SnapshotProperties

        public SnapshotProperties()

    • Method Detail

      • timeCreated

        public OffsetDateTime timeCreated()
        Get the timeCreated property: The time when the snapshot was created.
        Returns:
        the timeCreated value.

      • osType

        public OperatingSystemTypes osType()
        Get the osType property: The Operating System type.
        Returns:
        the osType value.

      • withOsType

        public SnapshotProperties withOsType​(OperatingSystemTypes osType)
        Set the osType property: The Operating System type.
        Parameters:
        osType - the osType value to set.
        Returns:
        the SnapshotProperties object itself.

      • hyperVGeneration

        public HyperVGeneration hyperVGeneration()
        Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
        Returns:
        the hyperVGeneration value.

      • withHyperVGeneration

        public SnapshotProperties withHyperVGeneration​(HyperVGeneration hyperVGeneration)
        Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
        Parameters:
        hyperVGeneration - the hyperVGeneration value to set.
        Returns:
        the SnapshotProperties object itself.

      • purchasePlan

        public PurchasePlanAutoGenerated purchasePlan()
        Get the purchasePlan property: Purchase plan information for the image from which the source disk for the snapshot was originally created.
        Returns:
        the purchasePlan value.

      • withPurchasePlan

        public SnapshotProperties withPurchasePlan​(PurchasePlanAutoGenerated purchasePlan)
        Set the purchasePlan property: Purchase plan information for the image from which the source disk for the snapshot was originally created.
        Parameters:
        purchasePlan - the purchasePlan value to set.
        Returns:
        the SnapshotProperties object itself.

      • supportedCapabilities

        public SupportedCapabilities supportedCapabilities()
        Get the supportedCapabilities property: List of supported capabilities for the image from which the source disk from the snapshot was originally created.
        Returns:
        the supportedCapabilities value.

      • withSupportedCapabilities

        public SnapshotProperties withSupportedCapabilities​(SupportedCapabilities supportedCapabilities)
        Set the supportedCapabilities property: List of supported capabilities for the image from which the source disk from the snapshot was originally created.
        Parameters:
        supportedCapabilities - the supportedCapabilities value to set.
        Returns:
        the SnapshotProperties object itself.

      • creationData

        public CreationData creationData()
        Get the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created.
        Returns:
        the creationData value.

      • withCreationData

        public SnapshotProperties withCreationData​(CreationData creationData)
        Set the creationData property: Disk source information. CreationData information cannot be changed after the disk has been created.
        Parameters:
        creationData - the creationData value to set.
        Returns:
        the SnapshotProperties object itself.

      • diskSizeGB

        public Integer diskSizeGB()
        Get the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
        Returns:
        the diskSizeGB value.

      • withDiskSizeGB

        public SnapshotProperties withDiskSizeGB​(Integer diskSizeGB)
        Set the diskSizeGB property: If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
        Parameters:
        diskSizeGB - the diskSizeGB value to set.
        Returns:
        the SnapshotProperties object itself.

      • diskSizeBytes

        public Long diskSizeBytes()
        Get the diskSizeBytes property: The size of the disk in bytes. This field is read only.
        Returns:
        the diskSizeBytes value.

      • diskState

        public DiskState diskState()
        Get the diskState property: The state of the snapshot.
        Returns:
        the diskState value.

      • uniqueId

        public String uniqueId()
        Get the uniqueId property: Unique Guid identifying the resource.
        Returns:
        the uniqueId value.

      • encryptionSettingsCollection

        public EncryptionSettingsCollection encryptionSettingsCollection()
        Get the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
        Returns:
        the encryptionSettingsCollection value.

      • withEncryptionSettingsCollection

        public SnapshotProperties withEncryptionSettingsCollection​(EncryptionSettingsCollection encryptionSettingsCollection)
        Set the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
        Parameters:
        encryptionSettingsCollection - the encryptionSettingsCollection value to set.
        Returns:
        the SnapshotProperties object itself.

      • provisioningState

        public String provisioningState()
        Get the provisioningState property: The disk provisioning state.
        Returns:
        the provisioningState value.

      • incremental

        public Boolean incremental()
        Get the incremental property: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
        Returns:
        the incremental value.

      • withIncremental

        public SnapshotProperties withIncremental​(Boolean incremental)
        Set the incremental property: Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
        Parameters:
        incremental - the incremental value to set.
        Returns:
        the SnapshotProperties object itself.

      • encryption

        public Encryption encryption()
        Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
        Returns:
        the encryption value.

      • withEncryption

        public SnapshotProperties withEncryption​(Encryption encryption)
        Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
        Parameters:
        encryption - the encryption value to set.
        Returns:
        the SnapshotProperties object itself.

      • networkAccessPolicy

        public NetworkAccessPolicy networkAccessPolicy()
        Get the networkAccessPolicy property: Policy for accessing the disk via network.
        Returns:
        the networkAccessPolicy value.

      • withNetworkAccessPolicy

        public SnapshotProperties withNetworkAccessPolicy​(NetworkAccessPolicy networkAccessPolicy)
        Set the networkAccessPolicy property: Policy for accessing the disk via network.
        Parameters:
        networkAccessPolicy - the networkAccessPolicy value to set.
        Returns:
        the SnapshotProperties object itself.

      • diskAccessId

        public String diskAccessId()
        Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.
        Returns:
        the diskAccessId value.

      • withDiskAccessId

        public SnapshotProperties withDiskAccessId​(String diskAccessId)
        Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.
        Parameters:
        diskAccessId - the diskAccessId value to set.
        Returns:
        the SnapshotProperties object itself.

      • securityProfile

        public DiskSecurityProfile securityProfile()
        Get the securityProfile property: Contains the security related information for the resource.
        Returns:
        the securityProfile value.

      • withSecurityProfile

        public SnapshotProperties withSecurityProfile​(DiskSecurityProfile securityProfile)
        Set the securityProfile property: Contains the security related information for the resource.
        Parameters:
        securityProfile - the securityProfile value to set.
        Returns:
        the SnapshotProperties object itself.

      • supportsHibernation

        public Boolean supportsHibernation()
        Get the supportsHibernation property: Indicates the OS on a snapshot supports hibernation.
        Returns:
        the supportsHibernation value.

      • withSupportsHibernation

        public SnapshotProperties withSupportsHibernation​(Boolean supportsHibernation)
        Set the supportsHibernation property: Indicates the OS on a snapshot supports hibernation.
        Parameters:
        supportsHibernation - the supportsHibernation value to set.
        Returns:
        the SnapshotProperties object itself.

      • publicNetworkAccess

        public PublicNetworkAccess publicNetworkAccess()
        Get the publicNetworkAccess property: Policy for controlling export on the disk.
        Returns:
        the publicNetworkAccess value.

      • withPublicNetworkAccess

        public SnapshotProperties withPublicNetworkAccess​(PublicNetworkAccess publicNetworkAccess)
        Set the publicNetworkAccess property: Policy for controlling export on the disk.
        Parameters:
        publicNetworkAccess - the publicNetworkAccess value to set.
        Returns:
        the SnapshotProperties object itself.

      • completionPercent

        public Float completionPercent()
        Get the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.
        Returns:
        the completionPercent value.

      • withCompletionPercent

        public SnapshotProperties withCompletionPercent​(Float completionPercent)
        Set the completionPercent property: Percentage complete for the background copy when a resource is created via the CopyStart operation.
        Parameters:
        completionPercent - the completionPercent value to set.
        Returns:
        the SnapshotProperties object itself.

      • dataAccessAuthMode

        public DataAccessAuthMode dataAccessAuthMode()
        Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.
        Returns:
        the dataAccessAuthMode value.

      • withDataAccessAuthMode

        public SnapshotProperties withDataAccessAuthMode​(DataAccessAuthMode dataAccessAuthMode)
        Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk or snapshot.
        Parameters:
        dataAccessAuthMode - the dataAccessAuthMode value to set.
        Returns:
        the SnapshotProperties object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.