@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class Instance extends Object
A compute host. The image used to launch the instance determines its operating system and other software. The shape specified during the launch process determines the number of CPUs and memory allocated to the 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 Instance.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 Instance.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Instance.Builder |
static class |
Instance.LaunchMode
Specifies the configuration mode for launching virtual machine (VM) instances.
|
static class |
Instance.LifecycleState
The current state of the instance.
|
| Constructor and Description |
|---|
Instance(String availabilityDomain,
String compartmentId,
String dedicatedVmHostId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,Object> extendedMetadata,
String faultDomain,
Map<String,String> freeformTags,
String id,
String imageId,
String ipxeScript,
Instance.LaunchMode launchMode,
LaunchOptions launchOptions,
InstanceOptions instanceOptions,
InstanceAvailabilityConfig availabilityConfig,
Instance.LifecycleState lifecycleState,
Map<String,String> metadata,
String region,
String shape,
InstanceShapeConfig shapeConfig,
InstanceSourceDetails sourceDetails,
Map<String,Map<String,Object>> systemTags,
Date timeCreated,
InstanceAgentConfig agentConfig,
Date timeMaintenanceRebootDue,
PlatformConfig platformConfig)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Instance.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
InstanceAgentConfig |
getAgentConfig() |
InstanceAvailabilityConfig |
getAvailabilityConfig() |
String |
getAvailabilityDomain()
The availability domain the instance is running in.
|
String |
getCompartmentId()
The OCID of the compartment that contains the instance.
|
String |
getDedicatedVmHostId()
The OCID of dedicated VM host.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,Object> |
getExtendedMetadata()
Additional metadata key/value pairs that you provide.
|
String |
getFaultDomain()
The name of the fault domain the instance is running in.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the instance.
|
String |
getImageId()
Deprecated.
|
InstanceOptions |
getInstanceOptions() |
String |
getIpxeScript()
When a bare metal or virtual machine
instance boots, the iPXE firmware that runs on the instance is
configured to run an iPXE script to continue the boot process.
|
Instance.LaunchMode |
getLaunchMode()
Specifies the configuration mode for launching virtual machine (VM) instances.
|
LaunchOptions |
getLaunchOptions() |
Instance.LifecycleState |
getLifecycleState()
The current state of the instance.
|
Map<String,String> |
getMetadata()
Custom metadata that you provide.
|
PlatformConfig |
getPlatformConfig() |
String |
getRegion()
The region that contains the availability domain the instance is running in.
|
String |
getShape()
The shape of the instance.
|
InstanceShapeConfig |
getShapeConfig() |
InstanceSourceDetails |
getSourceDetails() |
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time the instance was created, in the format defined by RFC3339.
|
Date |
getTimeMaintenanceRebootDue()
The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.
|
int |
hashCode() |
Instance.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"availabilityDomain","compartmentId","dedicatedVmHostId","definedTags","displayName","extendedMetadata","faultDomain","freeformTags","id","imageId","ipxeScript","launchMode","launchOptions","instanceOptions","availabilityConfig","lifecycleState","metadata","region","shape","shapeConfig","sourceDetails","systemTags","timeCreated","agentConfig","timeMaintenanceRebootDue","platformConfig"}) @Deprecated public Instance(String availabilityDomain, String compartmentId, String dedicatedVmHostId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,Object> extendedMetadata, String faultDomain, Map<String,String> freeformTags, String id, String imageId, String ipxeScript, Instance.LaunchMode launchMode, LaunchOptions launchOptions, InstanceOptions instanceOptions, InstanceAvailabilityConfig availabilityConfig, Instance.LifecycleState lifecycleState, Map<String,String> metadata, String region, String shape, InstanceShapeConfig shapeConfig, InstanceSourceDetails sourceDetails, Map<String,Map<String,Object>> systemTags, Date timeCreated, InstanceAgentConfig agentConfig, Date timeMaintenanceRebootDue, PlatformConfig platformConfig)
public static Instance.Builder builder()
Create a new builder.
public Instance.Builder toBuilder()
public String getAvailabilityDomain()
The availability domain the instance is running in.
Example: `Uocm:PHX-AD-1`
public String getCompartmentId()
The OCID of the compartment that contains the instance.
public String getDedicatedVmHostId()
The OCID of dedicated VM host.
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\"}}`
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example: `My bare metal instance`
public Map<String,Object> getExtendedMetadata()
Additional metadata key/value pairs that you provide. They serve the same purpose and functionality
as fields in the metadata object.
They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only).
public String getFaultDomain()
The name of the fault domain the instance is running in.
A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.
If you do not specify the fault domain, the system selects one for you.
Example: `FAULT-DOMAIN-1`
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\"}`
public String getId()
The OCID of the instance.
public String getImageId()
Deprecated. Use sourceDetails instead.
public String getIpxeScript()
When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.
If you want more control over the boot process, you can provide your own custom iPXE script that will run when the instance boots; however, you should be aware that the same iPXE script will run every time an instance boots; not only after the initial LaunchInstance call.
The default iPXE script connects to the instance's local boot volume over iSCSI and performs a network boot. If you use a custom iPXE script and want to network-boot from the instance's local boot volume over iSCSI the same way as the default iPXE script, you should use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.
For more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see [Bring Your Own Image](https://docs.cloud.oracle.com/Content/Compute/References/bringyourownimage.htm).
For more information about iPXE, see http://ipxe.org.
public Instance.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.public LaunchOptions getLaunchOptions()
public InstanceOptions getInstanceOptions()
public InstanceAvailabilityConfig getAvailabilityConfig()
public Instance.LifecycleState getLifecycleState()
The current state of the instance.
public String getRegion()
The region that contains the availability domain the instance is running in.
For the us-phoenix-1 and us-ashburn-1 regions, `phx` and `iad` are returned, respectively. For all other regions, the full region name is returned.
Examples: `phx`, `eu-frankfurt-1`
public String getShape()
The shape of the instance. The shape determines the number of CPUs and the amount of memory
allocated to the instance. You can enumerate all available shapes by calling
listShapes.
public InstanceShapeConfig getShapeConfig()
public InstanceSourceDetails getSourceDetails()
public Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
public Date getTimeCreated()
The date and time the instance was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
public InstanceAgentConfig getAgentConfig()
public Date getTimeMaintenanceRebootDue()
The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.
After that time if instance hasn’t been rebooted, Oracle will reboot the instance within 24 hours of the due time.
Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state.
Example: 2018-05-25T21:10:29.600Z
public PlatformConfig getPlatformConfig()
Copyright © 2016–2021. All rights reserved.