azurecompute/src/main/java/org/jclouds/azurecompute/domain/DataVirtualHardDisk.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.jclouds.azurecompute.domain;

import com.google.auto.value.AutoValue;
import org.jclouds.javax.annotation.Nullable;

import java.net.URI;

/**
 * @see <a href="https://msdn.microsoft.com/en-us/library/azure/jj157193.aspx#DataVirtualHardDisks" >api</a>
 */
@AutoValue
public abstract class DataVirtualHardDisk {

   public enum Caching {

      READ_ONLY,
      READ_WRITE,
      NONE;

      public static Caching fromString(final String text) {
         if (text != null) {
            for (Caching caching : Caching.values()) {
               if (text.equalsIgnoreCase(caching.name())) {
                  return caching;
               }
            }
         }
         return NONE;
      }

   }

   /**
    * Specifies the caching mode of the operating system disk. This setting impacts the consistency and performance of
    * the disk. Possible values are: ReadOnly ReadWrite The default value is ReadWrite
    */
   @Nullable
   public abstract Caching hostCaching();

   /**
    * Required if an existing disk is being used to create a Virtual Machine. Specifies the name of a new or existing
    * disk
    */
   @Nullable
   public abstract String diskName();

   /**
    * Specifies the Logical Unit Number (LUN) for the data disk. If the disk is the first disk that is added, this
    * element is optional and the default value of 0 is used. If more than one disk is being added, this element is
    * required.
    * <p/>
    * You can use Get Role to find the LUN numbers that are already being used. Valid LUN values are 0 through 31
    */
   @Nullable
   public abstract Integer lun();

   /**
    * Specifies the size, in GB, of an empty disk to be attached to the Virtual Machine.If the disk that is being added
    * is already registered in the subscription, this element is ignored.If the disk and VHD is being created by Azure
    * as it is added, this element defines the size of the new disk.
    * <p/>
    * The number of disks that can be added to a Virtual Machine is limited by the size of the machine.
    * <p/>
    * This element is used with the MediaLink element.
    */
   @Nullable
   public abstract Integer logicalDiskSizeInGB();

   /**
    * If the disk that is being added is already registered in the subscription or the VHD for the disk already exists
    * in blob storage, this element is ignored. If a VHD file does not exist in blob storage, this element defines the
    * location of the new VHD that is created when the new disk is added. Example:
    * http://example.blob.core.windows.net/disks/mydatadisk.vhd
    */
   @Nullable
   public abstract URI mediaLink();

   /**
    * This property identifies the type of the storage account for the backing VHD. If the backing VHD is in an
    * Provisioned Storage account, “Provisioned” is returned otherwise “Standard” is returned.
    * <p/>
    * This property is only returned with a version header of 2014-10-01 or newer
    */
   @Nullable
   public abstract String ioType();

   public static DataVirtualHardDisk create(final Caching hostCaching, final String diskName,
           final Integer lun, final Integer logicalDiskSizeInGB, final URI mediaLink, final String ioType) {

      return new AutoValue_DataVirtualHardDisk(hostCaching, diskName, lun, logicalDiskSizeInGB, mediaLink, ioType);
   }
}