Package com.oracle.bmc.core.model

Class Image

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Image
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A boot disk image for launching an instance.

    For more information, see Overview of the Compute Service.

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

    *Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
    Note: Objects should always be created or deserialized using the Image.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Image.Builder, which maintain a set of all explicitly set fields called Image.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Image.Builder builder()
        Create a new builder.

      • getBaseImageId

        public String getBaseImageId()
        The OCID of the image originally used to launch the instance.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the instance you want to use as the basis for the image.
        Returns:
        the value

      • getCreateImageAllowed

        public Boolean getCreateImageAllowed()
        Whether instances launched with this image can be used to create new images.

        For example, you cannot create an image of an Oracle Database instance.

        Example: true

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name for the image.

        It does not have to be unique, and it’s changeable. Avoid entering confidential information.

        You cannot use a platform image name as a custom image name.

        Example: My custom Oracle Linux image

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getId

        public String getId()
        The OCID of the image.
        Returns:
        the value

      • getLaunchMode

        public Image.LaunchMode getLaunchMode()
        Specifies the configuration mode for launching virtual machine (VM) instances.

        The configuration modes are: * NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers. * CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

        Returns:
        the value

      • getOperatingSystem

        public String getOperatingSystem()
        The image’s operating system.

        Example: Oracle Linux

        Returns:
        the value

      • getOperatingSystemVersion

        public String getOperatingSystemVersion()
        The image’s operating system version.

        Example: 7.2

        Returns:
        the value

      • getListingType

        public Image.ListingType getListingType()
        The listing type of the image.

        The default value is “NONE”.

        Returns:
        the value

      • getSizeInMBs

        public Long getSizeInMBs()
        The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes).

        Note this is not the same as the size of the image when it was exported or the actual size of the image.

        Example: 47694

        Returns:
        the value

      • getBillableSizeInGBs

        public Long getBillableSizeInGBs()
        The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes).

        Example: 100

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the image was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel