Class LaunchInstanceDetails
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.cloudmigrations.model.LaunchInstanceDetails
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20220919") public final class LaunchInstanceDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Instance launch details.Use the sourceDetails parameter to specify whether a boot volume or an image should be used to launch a new instance.
Note: Objects should always be created or deserialized using theLaunchInstanceDetails.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 theLaunchInstanceDetails.Builder
, which maintain a set of all explicitly set fields calledLaunchInstanceDetails.Builder.__explicitlySet__
. ThehashCode()
andequals(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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LaunchInstanceDetails.Builder
-
Constructor Summary
Constructors Constructor Description LaunchInstanceDetails(String availabilityDomain, String capacityReservationId, String compartmentId, CreateVnicDetails createVnicDetails, String dedicatedVmHostId, Map<String,Map<String,Object>> definedTags, String displayName, String faultDomain, Map<String,String> freeformTags, String hostnameLabel, String ipxeScript, InstanceOptions instanceOptions, PreemptibleInstanceConfigDetails preemptibleInstanceConfig, LaunchInstanceAgentConfigDetails agentConfig, String shape, LaunchInstanceShapeConfigDetails shapeConfig, InstanceSourceDetails sourceDetails, Boolean isPvEncryptionInTransitEnabled)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LaunchInstanceDetails.Builder
builder()
Create a new builder.boolean
equals(Object o)
LaunchInstanceAgentConfigDetails
getAgentConfig()
String
getAvailabilityDomain()
The availability domain of the instance.String
getCapacityReservationId()
The OCID of the compute capacity reservation under which this instance is launched.String
getCompartmentId()
The OCID of the compartment.CreateVnicDetails
getCreateVnicDetails()
String
getDedicatedVmHostId()
The OCID of the dedicated VM host.Map<String,Map<String,Object>>
getDefinedTags()
Defined tags for this resource.String
getDisplayName()
A user-friendly name.String
getFaultDomain()
A fault domain is a grouping of hardware and infrastructure within an availability domain.Map<String,String>
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.String
getHostnameLabel()
Deprecated.InstanceOptions
getInstanceOptions()
String
getIpxeScript()
This is an advanced option.Boolean
getIsPvEncryptionInTransitEnabled()
Whether to enable in-transit encryption for the data volume’s paravirtualized attachment.PreemptibleInstanceConfigDetails
getPreemptibleInstanceConfig()
String
getShape()
The shape of an instance.LaunchInstanceShapeConfigDetails
getShapeConfig()
InstanceSourceDetails
getSourceDetails()
int
hashCode()
LaunchInstanceDetails.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
LaunchInstanceDetails
@Deprecated @ConstructorProperties({"availabilityDomain","capacityReservationId","compartmentId","createVnicDetails","dedicatedVmHostId","definedTags","displayName","faultDomain","freeformTags","hostnameLabel","ipxeScript","instanceOptions","preemptibleInstanceConfig","agentConfig","shape","shapeConfig","sourceDetails","isPvEncryptionInTransitEnabled"}) public LaunchInstanceDetails(String availabilityDomain, String capacityReservationId, String compartmentId, CreateVnicDetails createVnicDetails, String dedicatedVmHostId, Map<String,Map<String,Object>> definedTags, String displayName, String faultDomain, Map<String,String> freeformTags, String hostnameLabel, String ipxeScript, InstanceOptions instanceOptions, PreemptibleInstanceConfigDetails preemptibleInstanceConfig, LaunchInstanceAgentConfigDetails agentConfig, String shape, LaunchInstanceShapeConfigDetails shapeConfig, InstanceSourceDetails sourceDetails, Boolean isPvEncryptionInTransitEnabled)
Deprecated.
-
-
Method Detail
-
builder
public static LaunchInstanceDetails.Builder builder()
Create a new builder.
-
toBuilder
public LaunchInstanceDetails.Builder toBuilder()
-
getAvailabilityDomain
public String getAvailabilityDomain()
The availability domain of the instance.Example: Uocm:PHX-AD-1
- Returns:
- the value
-
getCapacityReservationId
public String getCapacityReservationId()
The OCID of the compute capacity reservation under which this instance is launched.You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see Capacity Reservations.
- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment.- Returns:
- the value
-
getCreateVnicDetails
public CreateVnicDetails getCreateVnicDetails()
-
getDedicatedVmHostId
public String getDedicatedVmHostId()
The OCID of the dedicated VM host.- 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. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns:
- the value
-
getDisplayName
public String getDisplayName()
A user-friendly name.Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns:
- the value
-
getFaultDomain
public String getFaultDomain()
A fault domain is a grouping of hardware and infrastructure within an availability domain.Each availability domain contains three fault domains. Fault domains lets 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.
To get a list of fault domains, use the
listFaultDomains
operation in the Identity and Access Management Service API.Example: FAULT-DOMAIN-1
- Returns:
- the value
-
getFreeformTags
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.It exists only for cross-compatibility. Example: {“bar-key”: “value”}
- Returns:
- the value
-
getHostnameLabel
public String getHostnameLabel()
Deprecated.Instead use hostnameLabel in
CreateVnicDetails
. If you provide both, the values must match.- Returns:
- the value
-
getIpxeScript
public String getIpxeScript()
This is an advanced option.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. Be aware that the same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call.
By default, the 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 in the same way as the default iPXE script, use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.
If your instance boot volume type is paravirtualized, the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. If your instance boot volume type is paravirtualized and you use custom iPXE to perform network-boot into your instance, the primary boot volume is attached as a data volume through the virtio-scsi drive.
For more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see [Bring Your Own Image](https://docs.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm).
For more information about iPXE, see http://ipxe.org.
- Returns:
- the value
-
getInstanceOptions
public InstanceOptions getInstanceOptions()
-
getPreemptibleInstanceConfig
public PreemptibleInstanceConfigDetails getPreemptibleInstanceConfig()
-
getAgentConfig
public LaunchInstanceAgentConfigDetails getAgentConfig()
-
getShape
public String getShape()
The shape of an instance.The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
You can enumerate all available shapes by calling
listShapes
.- Returns:
- the value
-
getShapeConfig
public LaunchInstanceShapeConfigDetails getShapeConfig()
-
getSourceDetails
public InstanceSourceDetails getSourceDetails()
-
getIsPvEncryptionInTransitEnabled
public Boolean getIsPvEncryptionInTransitEnabled()
Whether to enable in-transit encryption for the data volume’s paravirtualized attachment.This field applies to both block volumes and boot volumes. By default, the value is false.
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toString
in classcom.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 classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-