azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.batch.protocol.models.OSDisk.yml

### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.OSDisk"
fullName: "com.microsoft.azure.batch.protocol.models.OSDisk"
name: "OSDisk"
nameWithType: "OSDisk"
summary: "Settings for the operating system disk of the compute node (VM)."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **OSDisk**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.OSDisk()"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.OSDisk()"
  name: "OSDisk()"
  nameWithType: "OSDisk.OSDisk()"
  syntax: "public OSDisk()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.caching()"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.caching()"
  name: "caching()"
  nameWithType: "OSDisk.caching()"
  summary: "Get possible values include: 'none', 'read<wbr>Only', 'read<wbr>Write'."
  syntax: "public CachingType caching()"
  desc: "Get possible values include: 'none', 'readOnly', 'readWrite'."
  returns:
    description: "the caching value"
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CachingType?alt=com.microsoft.azure.batch.protocol.models.CachingType&text=CachingType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.diskSizeGB()"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.diskSizeGB()"
  name: "diskSizeGB()"
  nameWithType: "OSDisk.diskSizeGB()"
  summary: "Get the disk<wbr>SizeGB value."
  syntax: "public Integer diskSizeGB()"
  desc: "Get the diskSizeGB value."
  returns:
    description: "the diskSizeGB value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.ephemeralOSDiskSettings()"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.ephemeralOSDiskSettings()"
  name: "ephemeralOSDiskSettings()"
  nameWithType: "OSDisk.ephemeralOSDiskSettings()"
  summary: "Get the ephemeral<wbr>OSDisk<wbr>Settings value."
  syntax: "public DiffDiskSettings ephemeralOSDiskSettings()"
  desc: "Get the ephemeralOSDiskSettings value."
  returns:
    description: "the ephemeralOSDiskSettings value"
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.DiffDiskSettings?alt=com.microsoft.azure.batch.protocol.models.DiffDiskSettings&text=DiffDiskSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.managedDisk()"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.managedDisk()"
  name: "managedDisk()"
  nameWithType: "OSDisk.managedDisk()"
  summary: "Get the managed<wbr>Disk value."
  syntax: "public ManagedDisk managedDisk()"
  desc: "Get the managedDisk value."
  returns:
    description: "the managedDisk value"
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ManagedDisk?alt=com.microsoft.azure.batch.protocol.models.ManagedDisk&text=ManagedDisk\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.withCaching(com.microsoft.azure.batch.protocol.models.CachingType)"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.withCaching(CachingType caching)"
  name: "withCaching(CachingType caching)"
  nameWithType: "OSDisk.withCaching(CachingType caching)"
  summary: "Set possible values include: 'none', 'read<wbr>Only', 'read<wbr>Write'."
  parameters:
  - description: "the caching value to set"
    name: "caching"
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CachingType?alt=com.microsoft.azure.batch.protocol.models.CachingType&text=CachingType\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public OSDisk withCaching(CachingType caching)"
  desc: "Set possible values include: 'none', 'readOnly', 'readWrite'."
  returns:
    description: "the OSDisk object itself."
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OSDisk?alt=com.microsoft.azure.batch.protocol.models.OSDisk&text=OSDisk\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.withDiskSizeGB(java.lang.Integer)"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.withDiskSizeGB(Integer diskSizeGB)"
  name: "withDiskSizeGB(Integer diskSizeGB)"
  nameWithType: "OSDisk.withDiskSizeGB(Integer diskSizeGB)"
  summary: "Set the disk<wbr>SizeGB value."
  parameters:
  - description: "the diskSizeGB value to set"
    name: "diskSizeGB"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public OSDisk withDiskSizeGB(Integer diskSizeGB)"
  desc: "Set the diskSizeGB value."
  returns:
    description: "the OSDisk object itself."
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OSDisk?alt=com.microsoft.azure.batch.protocol.models.OSDisk&text=OSDisk\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.withEphemeralOSDiskSettings(com.microsoft.azure.batch.protocol.models.DiffDiskSettings)"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.withEphemeralOSDiskSettings(DiffDiskSettings ephemeralOSDiskSettings)"
  name: "withEphemeralOSDiskSettings(DiffDiskSettings ephemeralOSDiskSettings)"
  nameWithType: "OSDisk.withEphemeralOSDiskSettings(DiffDiskSettings ephemeralOSDiskSettings)"
  summary: "Set the ephemeral<wbr>OSDisk<wbr>Settings value."
  parameters:
  - description: "the ephemeralOSDiskSettings value to set"
    name: "ephemeralOSDiskSettings"
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.DiffDiskSettings?alt=com.microsoft.azure.batch.protocol.models.DiffDiskSettings&text=DiffDiskSettings\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public OSDisk withEphemeralOSDiskSettings(DiffDiskSettings ephemeralOSDiskSettings)"
  desc: "Set the ephemeralOSDiskSettings value."
  returns:
    description: "the OSDisk object itself."
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OSDisk?alt=com.microsoft.azure.batch.protocol.models.OSDisk&text=OSDisk\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.withManagedDisk(com.microsoft.azure.batch.protocol.models.ManagedDisk)"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.withManagedDisk(ManagedDisk managedDisk)"
  name: "withManagedDisk(ManagedDisk managedDisk)"
  nameWithType: "OSDisk.withManagedDisk(ManagedDisk managedDisk)"
  summary: "Set the managed<wbr>Disk value."
  parameters:
  - description: "the managedDisk value to set"
    name: "managedDisk"
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ManagedDisk?alt=com.microsoft.azure.batch.protocol.models.ManagedDisk&text=ManagedDisk\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public OSDisk withManagedDisk(ManagedDisk managedDisk)"
  desc: "Set the managedDisk value."
  returns:
    description: "the OSDisk object itself."
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OSDisk?alt=com.microsoft.azure.batch.protocol.models.OSDisk&text=OSDisk\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.withWriteAcceleratorEnabled(java.lang.Boolean)"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.withWriteAcceleratorEnabled(Boolean writeAcceleratorEnabled)"
  name: "withWriteAcceleratorEnabled(Boolean writeAcceleratorEnabled)"
  nameWithType: "OSDisk.withWriteAcceleratorEnabled(Boolean writeAcceleratorEnabled)"
  summary: "Set the write<wbr>Accelerator<wbr>Enabled value."
  parameters:
  - description: "the writeAcceleratorEnabled value to set"
    name: "writeAcceleratorEnabled"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  syntax: "public OSDisk withWriteAcceleratorEnabled(Boolean writeAcceleratorEnabled)"
  desc: "Set the writeAcceleratorEnabled value."
  returns:
    description: "the OSDisk object itself."
    type: "<xref href=\"com.microsoft.azure.batch.protocol.models.OSDisk?alt=com.microsoft.azure.batch.protocol.models.OSDisk&text=OSDisk\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.OSDisk.writeAcceleratorEnabled()"
  fullName: "com.microsoft.azure.batch.protocol.models.OSDisk.writeAcceleratorEnabled()"
  name: "writeAcceleratorEnabled()"
  nameWithType: "OSDisk.writeAcceleratorEnabled()"
  summary: "Get the write<wbr>Accelerator<wbr>Enabled value."
  syntax: "public Boolean writeAcceleratorEnabled()"
  desc: "Get the writeAcceleratorEnabled value."
  returns:
    description: "the writeAcceleratorEnabled value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
type: "class"
desc: "Settings for the operating system disk of the compute node (VM)."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.2.0