java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.datacc.model.VmInstance

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20251101")
public final class VmInstance
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
VM instance details.
Note: Objects should always be created or deserialized using the VmInstance.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 VmInstance.Builder, which maintain a set of all explicitly set fields called VmInstance.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).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VmInstance.Builder

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
VmInstance(String id, String compartmentId, String displayName, String description, String infrastructureId, Integer cpusEnabled, Double memorySizeInGBs, Double bootStorageSizeInGBs, Double dataStorageSizeInGBs, Map<String,Map<String,Object>> definedTags, Map<String,String> freeformTags, Map<String,Map<String,Object>> systemTags, String imageId, String serverId, List<String> sshPublicKeys, VmInstanceLifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, String domainName, String timeZone, List<String> dnsServers, List<String> ntpServers, String hostname, String ipAddress, String netmask, String gateway, String vlanId, String userdata, Map<String,String> metadata, String vmNetworkId)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VmInstance.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`Double`	`getBootStorageSizeInGBs()`	Boot storage memory to be allocated in GBs.
`String`	`getCompartmentId()`	The OCID of the compartment containing the VM instance.
`Integer`	`getCpusEnabled()`	The number of CPU cores enabled for each VM instance.
`Double`	`getDataStorageSizeInGBs()`	Data storage to be allocated in GBs.
`Map<String,Map<String,Object>>`	`getDefinedTags()`	Defined tags for this resource.
`String`	`getDescription()`	VM instance description.
`String`	`getDisplayName()`	VM instance display name.
`List<String>`	`getDnsServers()`	The list of DNS server IP addresses.
`String`	`getDomainName()`	The domain name of the VM instance.
`Map<String,String>`	`getFreeformTags()`	Simple key-value pair that is applied without any predefined name, type or scope.
`String`	`getGateway()`	The gateway IP address of the VM instance network.
`String`	`getHostname()`	The host name of the instance.
`String`	`getId()`	The OCID of the VM instance.
`String`	`getImageId()`	The OCID of the VM custom instance uploaded.
`String`	`getInfrastructureId()`	The OCID of the Database Infrastructure.
`String`	`getIpAddress()`	The IP address of the instance.
`String`	`getLifecycleDetails()`	Lifecycle state details of the VM instance.
`VmInstanceLifecycleState`	`getLifecycleState()`	The current state of the VM instance.
`Double`	`getMemorySizeInGBs()`	The memory to be allocated in GBs.
`Map<String,String>`	`getMetadata()`	Custom metadata key/value pairs which can be used to: - Provide information to Cloud-Init to be used for various system initialization tasks.
`String`	`getNetmask()`	The netmask of the VM instance network.
`List<String>`	`getNtpServers()`	The list of NTP server addresses.
`String`	`getServerId()`	The OCID of the compute node on which VM instance should be launched.
`List<String>`	`getSshPublicKeys()`	List of public key used for SSH access to the VM instance.
`Map<String,Map<String,Object>>`	`getSystemTags()`	Usage of system tag keys.
`Date`	`getTimeCreated()`	The time that the VM instance was created.
`Date`	`getTimeUpdated()`	The time that the VM instance was last updated.
`String`	`getTimeZone()`	The time zone to use for the VM instance.
`String`	`getUserdata()`	Base64-encoded data to be used by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration.
`String`	`getVlanId()`	The network VLAN ID.
`String`	`getVmNetworkId()`	The OCID of the VM Network.
`int`	`hashCode()`
`VmInstance.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VmInstance

@Deprecated
@ConstructorProperties({"id","compartmentId","displayName","description","infrastructureId","cpusEnabled","memorySizeInGBs","bootStorageSizeInGBs","dataStorageSizeInGBs","definedTags","freeformTags","systemTags","imageId","serverId","sshPublicKeys","lifecycleState","lifecycleDetails","timeCreated","timeUpdated","domainName","timeZone","dnsServers","ntpServers","hostname","ipAddress","netmask","gateway","vlanId","userdata","metadata","vmNetworkId"})
public VmInstance(String id,
                  String compartmentId,
                  String displayName,
                  String description,
                  String infrastructureId,
                  Integer cpusEnabled,
                  Double memorySizeInGBs,
                  Double bootStorageSizeInGBs,
                  Double dataStorageSizeInGBs,
                  Map<String,Map<String,Object>> definedTags,
                  Map<String,String> freeformTags,
                  Map<String,Map<String,Object>> systemTags,
                  String imageId,
                  String serverId,
                  List<String> sshPublicKeys,
                  VmInstanceLifecycleState lifecycleState,
                  String lifecycleDetails,
                  Date timeCreated,
                  Date timeUpdated,
                  String domainName,
                  String timeZone,
                  List<String> dnsServers,
                  List<String> ntpServers,
                  String hostname,
                  String ipAddress,
                  String netmask,
                  String gateway,
                  String vlanId,
                  String userdata,
                  Map<String,String> metadata,
                  String vmNetworkId)

Deprecated.

Method Detail
- builder
```
public static VmInstance.Builder builder()
```
  Create a new builder.
- toBuilder
```
public VmInstance.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID of the VM instance.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment containing the VM instance.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  VM instance display name.
  This name does not have to be unique, and is changeable.
  
  Returns:
  
  the value
- getDescription
```
public String getDescription()
```
  VM instance description.
  
  Returns:
  
  the value
- getInfrastructureId
```
public String getInfrastructureId()
```
  The OCID of the Database Infrastructure.
  
  Returns:
  
  the value
- getCpusEnabled
```
public Integer getCpusEnabled()
```
  The number of CPU cores enabled for each VM instance.
  
  Returns:
  
  the value
- getMemorySizeInGBs
```
public Double getMemorySizeInGBs()
```
  The memory to be allocated in GBs.
  
  Returns:
  
  the value
- getBootStorageSizeInGBs
```
public Double getBootStorageSizeInGBs()
```
  Boot storage memory to be allocated in GBs.
  
  Returns:
  
  the value
- getDataStorageSizeInGBs
```
public Double getDataStorageSizeInGBs()
```
  Data storage to be allocated in GBs.
  
  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
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  Simple key-value pair that is applied without any predefined name, type or scope.
  This tag option exists for cross-compatibility only. Example: {“bar-key”: “value”}
  
  Returns:
  
  the value
- getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
  Usage of system tag keys.
  These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }
  
  Returns:
  
  the value
- getImageId
```
public String getImageId()
```
  The OCID of the VM custom instance uploaded.
  
  Returns:
  
  the value
- getServerId
```
public String getServerId()
```
  The OCID of the compute node on which VM instance should be launched.
  
  Returns:
  
  the value
- getSshPublicKeys
```
public List<String> getSshPublicKeys()
```
  List of public key used for SSH access to the VM instance.
  
  Returns:
  
  the value
- getLifecycleState
```
public VmInstanceLifecycleState getLifecycleState()
```
  The current state of the VM instance.
  
  Returns:
  
  the value
- getLifecycleDetails
```
public String getLifecycleDetails()
```
  Lifecycle state details of the VM instance.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The time that the VM instance was created.
  An RFC3339 formatted datetime string.
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  The time that the VM instance was last updated.
  An RFC3339 formatted datetime string.
  
  Returns:
  
  the value
- getDomainName
```
public String getDomainName()
```
  The domain name of the VM instance.
  
  Returns:
  
  the value
- getTimeZone
```
public String getTimeZone()
```
  The time zone to use for the VM instance.
  
  Returns:
  
  the value
- getDnsServers
```
public List<String> getDnsServers()
```
  The list of DNS server IP addresses.
  Maximum of 3 allowed.
  
  Returns:
  
  the value
- getNtpServers
```
public List<String> getNtpServers()
```
  The list of NTP server addresses.
  Maximum of 3 allowed.
  
  Returns:
  
  the value
- getHostname
```
public String getHostname()
```
  The host name of the instance.
  
  Returns:
  
  the value
- getIpAddress
```
public String getIpAddress()
```
  The IP address of the instance.
  
  Returns:
  
  the value
- getNetmask
```
public String getNetmask()
```
  The netmask of the VM instance network.
  
  Returns:
  
  the value
- getGateway
```
public String getGateway()
```
  The gateway IP address of the VM instance network.
  
  Returns:
  
  the value
- getVlanId
```
public String getVlanId()
```
  The network VLAN ID.
  
  Returns:
  
  the value
- getUserdata
```
public String getUserdata()
```
  Base64-encoded data to be used by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration.
  For information about how to take advantage of user data, see the Cloud-Init Documentation.
  
  Returns:
  
  the value
- getMetadata
```
public Map<String,String> getMetadata()
```
  Custom metadata key/value pairs which can be used to: - Provide information to Cloud-Init to be used for various system initialization tasks.
  - Provide additional information which is exposed inside the instance context and can be queried or referenced by user-data scripts for dynamic configuration.
  Returns:
  
  the value
- getVmNetworkId
```
public String getVmNetworkId()
```
  The OCID of the VM Network.
  
  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

Class VmInstance

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

VmInstance

Method Detail

builder

toBuilder

getId

getCompartmentId

getDisplayName

getDescription

getInfrastructureId

getCpusEnabled

getMemorySizeInGBs

getBootStorageSizeInGBs

getDataStorageSizeInGBs

getDefinedTags

getFreeformTags

getSystemTags

getImageId

getServerId

getSshPublicKeys

getLifecycleState

getLifecycleDetails

getTimeCreated

getTimeUpdated

getDomainName

getTimeZone

getDnsServers

getNtpServers

getHostname

getIpAddress

getNetmask

getGateway

getVlanId

getUserdata

getMetadata

getVmNetworkId

toString

toString

equals

hashCode