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.ExplicitlySetBmcModelInstance 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 SummaryNested Classes Modifier and Type Class Description static classLaunchInstanceDetails.Builder
 - 
Constructor SummaryConstructors 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 SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LaunchInstanceDetails.Builderbuilder()Create a new builder.booleanequals(Object o)LaunchInstanceAgentConfigDetailsgetAgentConfig()StringgetAvailabilityDomain()The availability domain of the instance.StringgetCapacityReservationId()The OCID of the compute capacity reservation under which this instance is launched.StringgetCompartmentId()The OCID of the compartment.CreateVnicDetailsgetCreateVnicDetails()StringgetDedicatedVmHostId()The OCID of the dedicated VM host.Map<String,Map<String,Object>>getDefinedTags()Defined tags for this resource.StringgetDisplayName()A user-friendly name.StringgetFaultDomain()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.StringgetHostnameLabel()Deprecated.InstanceOptionsgetInstanceOptions()StringgetIpxeScript()This is an advanced option.BooleangetIsPvEncryptionInTransitEnabled()Whether to enable in-transit encryption for the data volume’s paravirtualized attachment.PreemptibleInstanceConfigDetailsgetPreemptibleInstanceConfig()StringgetShape()The shape of an instance.LaunchInstanceShapeConfigDetailsgetShapeConfig()InstanceSourceDetailsgetSourceDetails()inthashCode()LaunchInstanceDetails.BuildertoBuilder()StringtoString()StringtoString(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- 
builderpublic static LaunchInstanceDetails.Builder builder() Create a new builder.
 - 
toBuilderpublic LaunchInstanceDetails.Builder toBuilder() 
 - 
getAvailabilityDomainpublic String getAvailabilityDomain() The availability domain of the instance.Example: Uocm:PHX-AD-1 - Returns:
- the value
 
 - 
getCapacityReservationIdpublic 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
 
 - 
getCompartmentIdpublic String getCompartmentId() The OCID of the compartment.- Returns:
- the value
 
 - 
getCreateVnicDetailspublic CreateVnicDetails getCreateVnicDetails() 
 - 
getDedicatedVmHostIdpublic String getDedicatedVmHostId() The OCID of the dedicated VM host.- Returns:
- the value
 
 - 
getDefinedTagspublic 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
 
 - 
getDisplayNamepublic String getDisplayName() A user-friendly name.Does not have to be unique, and it’s changeable. Avoid entering confidential information. - Returns:
- the value
 
 - 
getFaultDomainpublic 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 listFaultDomainsoperation in the Identity and Access Management Service API.Example: FAULT-DOMAIN-1 - Returns:
- the value
 
 - 
getFreeformTagspublic 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
 
 - 
getHostnameLabelpublic String getHostnameLabel() Deprecated.Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.- Returns:
- the value
 
 - 
getIpxeScriptpublic 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
 
 - 
getInstanceOptionspublic InstanceOptions getInstanceOptions() 
 - 
getPreemptibleInstanceConfigpublic PreemptibleInstanceConfigDetails getPreemptibleInstanceConfig() 
 - 
getAgentConfigpublic LaunchInstanceAgentConfigDetails getAgentConfig() 
 - 
getShapepublic 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
 
 - 
getShapeConfigpublic LaunchInstanceShapeConfigDetails getShapeConfig() 
 - 
getSourceDetailspublic InstanceSourceDetails getSourceDetails() 
 - 
getIsPvEncryptionInTransitEnabledpublic 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
 
 - 
toStringpublic String toString() - Overrides:
- toStringin class- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
 
 - 
toStringpublic 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
 
 - 
equalspublic boolean equals(Object o) - Overrides:
- equalsin class- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
 
 
- 
 
-