Package com.oracle.bmc.core.model

Class UpdateInstanceDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class UpdateInstanceDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

    Note: Objects should always be created or deserialized using the 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 UpdateInstanceDetails.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).

    • Method Detail

      • getCapacityReservationId

        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.

        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. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • getSecurityAttributes

        public Map<String,​Map<String,​Object>> getSecurityAttributes()
        Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

        Example: {"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}

        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

      • getFreeformTags

        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"}

        Returns:
        the value

      • getMetadata

        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.

        Returns:
        the value

      • getExtendedMetadata

        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.

        Returns:
        the value

      • getShape

        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.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.

        To determine whether capacity is available for a specific shape before you change the shape of an instance, use the createComputeCapacityReport operation.

        If the instance is running when you change the shape, the instance is rebooted.

        Example: VM.Standard2.1

        Returns:
        the value

      • getUpdateOperationConstraint

        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.

        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 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

        Returns:
        the value

      • getTimeMaintenanceRebootDue

        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.oracle.com/iaas/Content/Compute/References/infrastructure-maintenance.htm).

        Example: 2018-05-25T21:10:29.600Z

        Returns:
        the value

      • getDedicatedVmHostId

        public String getDedicatedVmHostId()
        The OCID of the dedicated virtual machine host to place the instance on.

        Supported only if this VM instance was already placed on a dedicated virtual machine host - that is, you can’t move an instance from on-demand capacity to dedicated capacity, nor can you move an instance from dedicated capacity to on-demand capacity.

        Returns:
        the value

      • getLicensingConfigs

        public List<UpdateInstanceLicensingConfig> getLicensingConfigs()
        The list of liscensing configurations with target update values.
        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