com.oracle.bmc.core.model

Class Image

java.lang.Object

com.oracle.bmc.core.model.Image

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Image
extends Object

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.cloud.oracle.com/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 __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Image.Builder
static class	Image.LaunchMode Specifies the configuration mode for launching virtual machine (VM) instances.
static class	Image.LifecycleState

Constructor Summary

Constructors

Constructor and Description

Image(String baseImageId, String compartmentId, Boolean createImageAllowed, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, Image.LaunchMode launchMode, LaunchOptions launchOptions, Image.LifecycleState lifecycleState, String operatingSystem, String operatingSystemVersion, InstanceAgentFeatures agentFeatures, Long sizeInMBs, Date timeCreated) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Image.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
InstanceAgentFeatures	getAgentFeatures()
String	getBaseImageId() The OCID of the image originally used to launch the instance.
String	getCompartmentId() The OCID of the compartment containing the instance you want to use as the basis for the image.
Boolean	getCreateImageAllowed() Whether instances launched with this image can be used to create new images.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() A user-friendly name for the image.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of the image.
Image.LaunchMode	getLaunchMode() Specifies the configuration mode for launching virtual machine (VM) instances.
LaunchOptions	getLaunchOptions()
Image.LifecycleState	getLifecycleState()
String	getOperatingSystem() The image’s operating system.
String	getOperatingSystemVersion() The image’s operating system version.
Long	getSizeInMBs() The boot volume size for an instance launched from this image, (1 MB = 1048576 bytes).
Date	getTimeCreated() The date and time the image was created, in the format defined by RFC3339.
int	hashCode()
Image.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Image

@ConstructorProperties(value={"baseImageId","compartmentId","createImageAllowed","definedTags","displayName","freeformTags","id","launchMode","launchOptions","lifecycleState","operatingSystem","operatingSystemVersion","agentFeatures","sizeInMBs","timeCreated"})
 @Deprecated
public Image(String baseImageId,
                                                                                                                                                                                                                                                                                                String compartmentId,
                                                                                                                                                                                                                                                                                                Boolean createImageAllowed,
                                                                                                                                                                                                                                                                                                Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                String displayName,
                                                                                                                                                                                                                                                                                                Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                String id,
                                                                                                                                                                                                                                                                                                Image.LaunchMode launchMode,
                                                                                                                                                                                                                                                                                                LaunchOptions launchOptions,
                                                                                                                                                                                                                                                                                                Image.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                String operatingSystem,
                                                                                                                                                                                                                                                                                                String operatingSystemVersion,
                                                                                                                                                                                                                                                                                                InstanceAgentFeatures agentFeatures,
                                                                                                                                                                                                                                                                                                Long sizeInMBs,
                                                                                                                                                                                                                                                                                                Date timeCreated)

Deprecated.

Method Detail

builder

public static Image.Builder builder()

Create a new builder.

toBuilder

public Image.Builder toBuilder()

getBaseImageId

public String getBaseImageId()

The OCID of the image originally used to launch the instance.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the instance you want to use as the basis for the image.

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`

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\"}}`

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 an Oracle-provided image name as a custom image name.

Example: `My custom Oracle Linux image`

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\"}`

getId

public String getId()

The OCID of the image.

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 Oracle-provided 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.

getLaunchOptions

public LaunchOptions getLaunchOptions()

getLifecycleState

public Image.LifecycleState getLifecycleState()

getOperatingSystem

public String getOperatingSystem()

The image’s operating system.

Example: `Oracle Linux`

getOperatingSystemVersion

public String getOperatingSystemVersion()

The image’s operating system version.

Example: `7.2`

getAgentFeatures

public InstanceAgentFeatures getAgentFeatures()

getSizeInMBs

public Long getSizeInMBs()

The boot volume size for an instance launched from this image, (1 MB = 1048576 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`

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`

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object