@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class UpdateInstanceDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
UpdateInstanceDetails.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 UpdateInstanceDetails.Builder
, which maintain a
set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__
. The hashCode()
and
equals(Object)
methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__
into account.
The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the
constructor cannot distinguish explicit null
from unset null
).Modifier and Type | Class and Description |
---|---|
static class |
UpdateInstanceDetails.Builder |
static class |
UpdateInstanceDetails.UpdateOperationConstraint
The parameter acts as a fail-safe to prevent unwanted downtime when updating a running
instance.
|
Constructor and Description |
---|
UpdateInstanceDetails(String capacityReservationId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
UpdateInstanceAgentConfigDetails agentConfig,
Map<String,String> metadata,
Map<String,Object> extendedMetadata,
String shape,
UpdateInstanceShapeConfigDetails shapeConfig,
UpdateInstanceDetails.UpdateOperationConstraint updateOperationConstraint,
InstanceOptions instanceOptions,
String faultDomain,
UpdateLaunchOptions launchOptions,
UpdateInstanceAvailabilityConfigDetails availabilityConfig,
Date timeMaintenanceRebootDue)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static UpdateInstanceDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
UpdateInstanceAgentConfigDetails |
getAgentConfig() |
UpdateInstanceAvailabilityConfigDetails |
getAvailabilityConfig() |
String |
getCapacityReservationId()
The OCID of the compute capacity reservation this instance is launched under.
|
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()
A fault domain is a grouping of hardware and infrastructure within an availability domain.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
InstanceOptions |
getInstanceOptions() |
UpdateLaunchOptions |
getLaunchOptions() |
Map<String,String> |
getMetadata()
Custom metadata key/value string pairs that you provide.
|
String |
getShape()
The shape of the instance.
|
UpdateInstanceShapeConfigDetails |
getShapeConfig() |
Date |
getTimeMaintenanceRebootDue()
For a VM instance, resets the scheduled time that the instance will be reboot migrated for
infrastructure maintenance, in the format defined by
RFC3339.
|
UpdateInstanceDetails.UpdateOperationConstraint |
getUpdateOperationConstraint()
The parameter acts as a fail-safe to prevent unwanted downtime when updating a running
instance.
|
int |
hashCode() |
UpdateInstanceDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"capacityReservationId","definedTags","displayName","freeformTags","agentConfig","metadata","extendedMetadata","shape","shapeConfig","updateOperationConstraint","instanceOptions","faultDomain","launchOptions","availabilityConfig","timeMaintenanceRebootDue"}) public UpdateInstanceDetails(String capacityReservationId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, UpdateInstanceAgentConfigDetails agentConfig, Map<String,String> metadata, Map<String,Object> extendedMetadata, String shape, UpdateInstanceShapeConfigDetails shapeConfig, UpdateInstanceDetails.UpdateOperationConstraint updateOperationConstraint, InstanceOptions instanceOptions, String faultDomain, UpdateLaunchOptions launchOptions, UpdateInstanceAvailabilityConfigDetails availabilityConfig, Date timeMaintenanceRebootDue)
public static UpdateInstanceDetails.Builder builder()
Create a new builder.
public UpdateInstanceDetails.Builder toBuilder()
public String getCapacityReservationId()
The OCID of the compute capacity reservation this instance is launched under. You can remove the instance from a reservation by specifying an empty string as input for this field. For more information, see Capacity Reservations.
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.
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 UpdateInstanceAgentConfigDetails getAgentConfig()
public Map<String,String> getMetadata()
Custom metadata key/value string pairs that you provide. Any set of key/value pairs provided
here will completely replace the current set of key/value pairs in the metadata
field
on the instance.
The "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that already exist on the instance.
The combined size of the metadata
and extendedMetadata
objects can be a
maximum of 32,000 bytes.
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).
The "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that already exist on the instance.
The combined size of the metadata
and extendedMetadata
objects can be a
maximum of 32,000 bytes.
public String getShape()
The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. For more information about how to change shapes, and a list of shapes that are supported, see Editing an Instance.
For details about the CPUs, memory, and other properties of each shape, see [Compute Shapes](https://docs.cloud.oracle.com/iaas/Content/Compute/References/computeshapes.htm).
The new shape must be compatible with the image that was used to launch the instance. You
can enumerate all available shapes and determine image compatibility by calling listShapes
.
If the instance is running when you change the shape, the instance is rebooted.
Example: VM.Standard2.1
public UpdateInstanceShapeConfigDetails getShapeConfig()
public UpdateInstanceDetails.UpdateOperationConstraint getUpdateOperationConstraint()
The parameter acts as a fail-safe to prevent unwanted downtime when updating a running
instance. The default is ALLOW_DOWNTIME. * ALLOW_DOWNTIME
- Compute might reboot the
instance while updating the instance if a reboot is required. * AVOID_DOWNTIME
- If
the instance is in running state, Compute tries to update the instance without rebooting it.
If the instance requires a reboot to be updated, an error is returned and the instance is not
updated. If the instance is stopped, it is updated and remains in the stopped state.
public InstanceOptions getInstanceOptions()
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 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.
To get a list of fault domains, use the listFaultDomains
operation in the Identity and Access Management Service API.
Example: FAULT-DOMAIN-1
public UpdateLaunchOptions getLaunchOptions()
public UpdateInstanceAvailabilityConfigDetails getAvailabilityConfig()
public Date getTimeMaintenanceRebootDue()
For a VM instance, resets the scheduled time that the instance will be reboot migrated for infrastructure maintenance, in the format defined by RFC3339. If the instance hasn’t been rebooted after this date, Oracle reboots the instance within 24 hours of the time and date that maintenance is due.
To get the maximum possible date that a maintenance reboot can be extended, use getInstanceMaintenanceReboot
.
Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches the Stopped state.
To reboot migrate a bare metal instance, use the instanceAction
operation.
For more information, see [Infrastructure Maintenance](https://docs.cloud.oracle.com/iaas/Content/Compute/References/infrastructure-maintenance.htm).
Example: 2018-05-25T21:10:29.600Z
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2023. All rights reserved.