com.azure.resourcemanager.compute.fluent.models.SnapshotInner Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-compute Show documentation
Show all versions of azure-resourcemanager-compute Show documentation
This package contains Microsoft Azure Compute Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.compute.fluent.models;
import com.azure.core.annotation.Fluent;
import com.azure.core.management.Resource;
import com.azure.json.JsonReader;
import com.azure.json.JsonToken;
import com.azure.json.JsonWriter;
import com.azure.resourcemanager.compute.models.CopyCompletionError;
import com.azure.resourcemanager.compute.models.CreationData;
import com.azure.resourcemanager.compute.models.DataAccessAuthMode;
import com.azure.resourcemanager.compute.models.DiskSecurityProfile;
import com.azure.resourcemanager.compute.models.DiskState;
import com.azure.resourcemanager.compute.models.Encryption;
import com.azure.resourcemanager.compute.models.EncryptionSettingsCollection;
import com.azure.resourcemanager.compute.models.ExtendedLocation;
import com.azure.resourcemanager.compute.models.HyperVGeneration;
import com.azure.resourcemanager.compute.models.NetworkAccessPolicy;
import com.azure.resourcemanager.compute.models.OperatingSystemTypes;
import com.azure.resourcemanager.compute.models.PublicNetworkAccess;
import com.azure.resourcemanager.compute.models.PurchasePlanAutoGenerated;
import com.azure.resourcemanager.compute.models.SnapshotSku;
import com.azure.resourcemanager.compute.models.SupportedCapabilities;
import java.io.IOException;
import java.time.OffsetDateTime;
import java.util.Map;
/**
* Snapshot resource.
*/
@Fluent
public final class SnapshotInner extends Resource {
/*
* Unused. Always Null.
*/
private String managedBy;
/*
* The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for
* incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
*/
private SnapshotSku sku;
/*
* The extended location where the snapshot will be created. Extended location cannot be changed.
*/
private ExtendedLocation extendedLocation;
/*
* Snapshot resource properties.
*/
private SnapshotProperties innerProperties;
/*
* Fully qualified resource Id for the resource.
*/
private String id;
/*
* The name of the resource.
*/
private String name;
/*
* The type of the resource.
*/
private String type;
/**
* Creates an instance of SnapshotInner class.
*/
public SnapshotInner() {
}
/**
* Get the managedBy property: Unused. Always Null.
*
* @return the managedBy value.
*/
public String managedBy() {
return this.managedBy;
}
/**
* Get the sku property: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an
* optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as
* the previous snapshot.
*
* @return the sku value.
*/
public SnapshotSku sku() {
return this.sku;
}
/**
* Set the sku property: The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an
* optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as
* the previous snapshot.
*
* @param sku the sku value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withSku(SnapshotSku sku) {
this.sku = sku;
return this;
}
/**
* Get the extendedLocation property: The extended location where the snapshot will be created. Extended location
* cannot be changed.
*
* @return the extendedLocation value.
*/
public ExtendedLocation extendedLocation() {
return this.extendedLocation;
}
/**
* Set the extendedLocation property: The extended location where the snapshot will be created. Extended location
* cannot be changed.
*
* @param extendedLocation the extendedLocation value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withExtendedLocation(ExtendedLocation extendedLocation) {
this.extendedLocation = extendedLocation;
return this;
}
/**
* Get the innerProperties property: Snapshot resource properties.
*
* @return the innerProperties value.
*/
private SnapshotProperties innerProperties() {
return this.innerProperties;
}
/**
* Get the id property: Fully qualified resource Id for the resource.
*
* @return the id value.
*/
@Override
public String id() {
return this.id;
}
/**
* Get the name property: The name of the resource.
*
* @return the name value.
*/
@Override
public String name() {
return this.name;
}
/**
* Get the type property: The type of the resource.
*
* @return the type value.
*/
@Override
public String type() {
return this.type;
}
/**
* {@inheritDoc}
*/
@Override
public SnapshotInner withLocation(String location) {
super.withLocation(location);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public SnapshotInner withTags(Map tags) {
super.withTags(tags);
return this;
}
/**
* Get the timeCreated property: The time when the snapshot was created.
*
* @return the timeCreated value.
*/
public OffsetDateTime timeCreated() {
return this.innerProperties() == null ? null : this.innerProperties().timeCreated();
}
/**
* Get the osType property: The Operating System type.
*
* @return the osType value.
*/
public OperatingSystemTypes osType() {
return this.innerProperties() == null ? null : this.innerProperties().osType();
}
/**
* Set the osType property: The Operating System type.
*
* @param osType the osType value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withOsType(OperatingSystemTypes osType) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withOsType(osType);
return this;
}
/**
* Get the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
*
* @return the hyperVGeneration value.
*/
public HyperVGeneration hyperVGeneration() {
return this.innerProperties() == null ? null : this.innerProperties().hyperVGeneration();
}
/**
* Set the hyperVGeneration property: The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
*
* @param hyperVGeneration the hyperVGeneration value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withHyperVGeneration(HyperVGeneration hyperVGeneration) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withHyperVGeneration(hyperVGeneration);
return this;
}
/**
* Get the purchasePlan property: Purchase plan information for the image from which the source disk for the
* snapshot was originally created.
*
* @return the purchasePlan value.
*/
public PurchasePlanAutoGenerated purchasePlan() {
return this.innerProperties() == null ? null : this.innerProperties().purchasePlan();
}
/**
* Set the purchasePlan property: Purchase plan information for the image from which the source disk for the
* snapshot was originally created.
*
* @param purchasePlan the purchasePlan value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withPurchasePlan(PurchasePlanAutoGenerated purchasePlan) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withPurchasePlan(purchasePlan);
return this;
}
/**
* Get the supportedCapabilities property: List of supported capabilities for the image from which the source disk
* from the snapshot was originally created.
*
* @return the supportedCapabilities value.
*/
public SupportedCapabilities supportedCapabilities() {
return this.innerProperties() == null ? null : this.innerProperties().supportedCapabilities();
}
/**
* Set the supportedCapabilities property: List of supported capabilities for the image from which the source disk
* from the snapshot was originally created.
*
* @param supportedCapabilities the supportedCapabilities value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withSupportedCapabilities(SupportedCapabilities supportedCapabilities) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withSupportedCapabilities(supportedCapabilities);
return this;
}
/**
* Get the creationData property: Disk source information. CreationData information cannot be changed after the disk
* has been created.
*
* @return the creationData value.
*/
public CreationData creationData() {
return this.innerProperties() == null ? null : this.innerProperties().creationData();
}
/**
* Set the creationData property: Disk source information. CreationData information cannot be changed after the disk
* has been created.
*
* @param creationData the creationData value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withCreationData(CreationData creationData) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withCreationData(creationData);
return this;
}
/**
* 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.
*
* @return the diskSizeGB value.
*/
public Integer diskSizeGB() {
return this.innerProperties() == null ? null : this.innerProperties().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.
*
* @param diskSizeGB the diskSizeGB value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withDiskSizeGB(Integer diskSizeGB) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withDiskSizeGB(diskSizeGB);
return this;
}
/**
* Get the diskSizeBytes property: The size of the disk in bytes. This field is read only.
*
* @return the diskSizeBytes value.
*/
public Long diskSizeBytes() {
return this.innerProperties() == null ? null : this.innerProperties().diskSizeBytes();
}
/**
* Get the diskState property: The state of the snapshot.
*
* @return the diskState value.
*/
public DiskState diskState() {
return this.innerProperties() == null ? null : this.innerProperties().diskState();
}
/**
* Get the uniqueId property: Unique Guid identifying the resource.
*
* @return the uniqueId value.
*/
public String uniqueId() {
return this.innerProperties() == null ? null : this.innerProperties().uniqueId();
}
/**
* Get the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can
* contain multiple encryption settings per disk or snapshot.
*
* @return the encryptionSettingsCollection value.
*/
public EncryptionSettingsCollection encryptionSettingsCollection() {
return this.innerProperties() == null ? null : this.innerProperties().encryptionSettingsCollection();
}
/**
* Set the encryptionSettingsCollection property: Encryption settings collection used be Azure Disk Encryption, can
* contain multiple encryption settings per disk or snapshot.
*
* @param encryptionSettingsCollection the encryptionSettingsCollection value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withEncryptionSettingsCollection(EncryptionSettingsCollection encryptionSettingsCollection) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withEncryptionSettingsCollection(encryptionSettingsCollection);
return this;
}
/**
* Get the provisioningState property: The disk provisioning state.
*
* @return the provisioningState value.
*/
public String provisioningState() {
return this.innerProperties() == null ? null : this.innerProperties().provisioningState();
}
/**
* 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.
*
* @return the incremental value.
*/
public Boolean incremental() {
return this.innerProperties() == null ? null : this.innerProperties().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.
*
* @param incremental the incremental value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withIncremental(Boolean incremental) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withIncremental(incremental);
return this;
}
/**
* Get the incrementalSnapshotFamilyId property: Incremental snapshots for a disk share an incremental snapshot
* family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
*
* @return the incrementalSnapshotFamilyId value.
*/
public String incrementalSnapshotFamilyId() {
return this.innerProperties() == null ? null : this.innerProperties().incrementalSnapshotFamilyId();
}
/**
* Get the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys
* or platform managed keys.
*
* @return the encryption value.
*/
public Encryption encryption() {
return this.innerProperties() == null ? null : this.innerProperties().encryption();
}
/**
* Set the encryption property: Encryption property can be used to encrypt data at rest with customer managed keys
* or platform managed keys.
*
* @param encryption the encryption value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withEncryption(Encryption encryption) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withEncryption(encryption);
return this;
}
/**
* Get the networkAccessPolicy property: Policy for accessing the disk via network.
*
* @return the networkAccessPolicy value.
*/
public NetworkAccessPolicy networkAccessPolicy() {
return this.innerProperties() == null ? null : this.innerProperties().networkAccessPolicy();
}
/**
* Set the networkAccessPolicy property: Policy for accessing the disk via network.
*
* @param networkAccessPolicy the networkAccessPolicy value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withNetworkAccessPolicy(NetworkAccessPolicy networkAccessPolicy) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withNetworkAccessPolicy(networkAccessPolicy);
return this;
}
/**
* Get the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.
*
* @return the diskAccessId value.
*/
public String diskAccessId() {
return this.innerProperties() == null ? null : this.innerProperties().diskAccessId();
}
/**
* Set the diskAccessId property: ARM id of the DiskAccess resource for using private endpoints on disks.
*
* @param diskAccessId the diskAccessId value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withDiskAccessId(String diskAccessId) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withDiskAccessId(diskAccessId);
return this;
}
/**
* Get the securityProfile property: Contains the security related information for the resource.
*
* @return the securityProfile value.
*/
public DiskSecurityProfile securityProfile() {
return this.innerProperties() == null ? null : this.innerProperties().securityProfile();
}
/**
* Set the securityProfile property: Contains the security related information for the resource.
*
* @param securityProfile the securityProfile value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withSecurityProfile(DiskSecurityProfile securityProfile) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withSecurityProfile(securityProfile);
return this;
}
/**
* Get the supportsHibernation property: Indicates the OS on a snapshot supports hibernation.
*
* @return the supportsHibernation value.
*/
public Boolean supportsHibernation() {
return this.innerProperties() == null ? null : this.innerProperties().supportsHibernation();
}
/**
* Set the supportsHibernation property: Indicates the OS on a snapshot supports hibernation.
*
* @param supportsHibernation the supportsHibernation value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withSupportsHibernation(Boolean supportsHibernation) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withSupportsHibernation(supportsHibernation);
return this;
}
/**
* Get the publicNetworkAccess property: Policy for controlling export on the disk.
*
* @return the publicNetworkAccess value.
*/
public PublicNetworkAccess publicNetworkAccess() {
return this.innerProperties() == null ? null : this.innerProperties().publicNetworkAccess();
}
/**
* Set the publicNetworkAccess property: Policy for controlling export on the disk.
*
* @param publicNetworkAccess the publicNetworkAccess value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withPublicNetworkAccess(publicNetworkAccess);
return this;
}
/**
* Get the completionPercent property: Percentage complete for the background copy when a resource is created via
* the CopyStart operation.
*
* @return the completionPercent value.
*/
public Float completionPercent() {
return this.innerProperties() == null ? null : this.innerProperties().completionPercent();
}
/**
* Set the completionPercent property: Percentage complete for the background copy when a resource is created via
* the CopyStart operation.
*
* @param completionPercent the completionPercent value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withCompletionPercent(Float completionPercent) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withCompletionPercent(completionPercent);
return this;
}
/**
* Get the copyCompletionError property: Indicates the error details if the background copy of a resource created
* via the CopyStart operation fails.
*
* @return the copyCompletionError value.
*/
public CopyCompletionError copyCompletionError() {
return this.innerProperties() == null ? null : this.innerProperties().copyCompletionError();
}
/**
* Set the copyCompletionError property: Indicates the error details if the background copy of a resource created
* via the CopyStart operation fails.
*
* @param copyCompletionError the copyCompletionError value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withCopyCompletionError(CopyCompletionError copyCompletionError) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withCopyCompletionError(copyCompletionError);
return this;
}
/**
* Get the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk
* or snapshot.
*
* @return the dataAccessAuthMode value.
*/
public DataAccessAuthMode dataAccessAuthMode() {
return this.innerProperties() == null ? null : this.innerProperties().dataAccessAuthMode();
}
/**
* Set the dataAccessAuthMode property: Additional authentication requirements when exporting or uploading to a disk
* or snapshot.
*
* @param dataAccessAuthMode the dataAccessAuthMode value to set.
* @return the SnapshotInner object itself.
*/
public SnapshotInner withDataAccessAuthMode(DataAccessAuthMode dataAccessAuthMode) {
if (this.innerProperties() == null) {
this.innerProperties = new SnapshotProperties();
}
this.innerProperties().withDataAccessAuthMode(dataAccessAuthMode);
return this;
}
/**
* Validates the instance.
*
* @throws IllegalArgumentException thrown if the instance is not valid.
*/
public void validate() {
if (sku() != null) {
sku().validate();
}
if (extendedLocation() != null) {
extendedLocation().validate();
}
if (innerProperties() != null) {
innerProperties().validate();
}
}
/**
* {@inheritDoc}
*/
@Override
public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
jsonWriter.writeStartObject();
jsonWriter.writeStringField("location", location());
jsonWriter.writeMapField("tags", tags(), (writer, element) -> writer.writeString(element));
jsonWriter.writeJsonField("sku", this.sku);
jsonWriter.writeJsonField("extendedLocation", this.extendedLocation);
jsonWriter.writeJsonField("properties", this.innerProperties);
return jsonWriter.writeEndObject();
}
/**
* Reads an instance of SnapshotInner from the JsonReader.
*
* @param jsonReader The JsonReader being read.
* @return An instance of SnapshotInner if the JsonReader was pointing to an instance of it, or null if it was
* pointing to JSON null.
* @throws IllegalStateException If the deserialized JSON object was missing any required properties.
* @throws IOException If an error occurs while reading the SnapshotInner.
*/
public static SnapshotInner fromJson(JsonReader jsonReader) throws IOException {
return jsonReader.readObject(reader -> {
SnapshotInner deserializedSnapshotInner = new SnapshotInner();
while (reader.nextToken() != JsonToken.END_OBJECT) {
String fieldName = reader.getFieldName();
reader.nextToken();
if ("id".equals(fieldName)) {
deserializedSnapshotInner.id = reader.getString();
} else if ("name".equals(fieldName)) {
deserializedSnapshotInner.name = reader.getString();
} else if ("type".equals(fieldName)) {
deserializedSnapshotInner.type = reader.getString();
} else if ("location".equals(fieldName)) {
deserializedSnapshotInner.withLocation(reader.getString());
} else if ("tags".equals(fieldName)) {
Map tags = reader.readMap(reader1 -> reader1.getString());
deserializedSnapshotInner.withTags(tags);
} else if ("managedBy".equals(fieldName)) {
deserializedSnapshotInner.managedBy = reader.getString();
} else if ("sku".equals(fieldName)) {
deserializedSnapshotInner.sku = SnapshotSku.fromJson(reader);
} else if ("extendedLocation".equals(fieldName)) {
deserializedSnapshotInner.extendedLocation = ExtendedLocation.fromJson(reader);
} else if ("properties".equals(fieldName)) {
deserializedSnapshotInner.innerProperties = SnapshotProperties.fromJson(reader);
} else {
reader.skipChildren();
}
}
return deserializedSnapshotInner;
});
}
}