Package com.ibm.cloud.is.vpc.v1.model

Class Instance

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class Instance
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Instance.

    • Method Detail

      • getAvailabilityPolicy

        public InstanceAvailabilityPolicy getAvailabilityPolicy()
        Gets the availabilityPolicy. The availability policy for this virtual server instance.
        Returns:
        the availabilityPolicy

      • getBandwidth

        public Long getBandwidth()
        Gets the bandwidth. The total bandwidth (in megabits per second) shared across the instance network attachments or instance network interfaces and storage volumes of the virtual server instance.
        Returns:
        the bandwidth

      • getCatalogOffering

        public InstanceCatalogOffering getCatalogOffering()
        Gets the catalogOffering. If present, this virtual server instance was provisioned from a [catalog](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user).
        Returns:
        the catalogOffering

      • getClusterNetwork

        public ClusterNetworkReference getClusterNetwork()
        Gets the clusterNetwork. If present, the cluster network that this virtual server instance resides in.
        Returns:
        the clusterNetwork

      • getClusterNetworkAttachments

        public List<InstanceClusterNetworkAttachmentReference> getClusterNetworkAttachments()
        Gets the clusterNetworkAttachments. The cluster network attachments for this virtual server instance. The cluster network attachments are ordered for consistent instance configuration.
        Returns:
        the clusterNetworkAttachments

      • getConfidentialComputeMode

        public String getConfidentialComputeMode()
        Gets the confidentialComputeMode. The confidential compute mode for this virtual server instance.
        Returns:
        the confidentialComputeMode

      • getCreatedAt

        public Date getCreatedAt()
        Gets the createdAt. The date and time that the virtual server instance was created.
        Returns:
        the createdAt

      • getCrn

        public String getCrn()
        Gets the crn. The CRN for this virtual server instance.
        Returns:
        the crn

      • getDedicatedHost

        public DedicatedHostReference getDedicatedHost()
        Gets the dedicatedHost. If present, the dedicated host this virtual server instance has been placed on.
        Returns:
        the dedicatedHost

      • getDisks

        public List<InstanceDisk> getDisks()
        Gets the disks. The instance disks for this virtual server instance.
        Returns:
        the disks

      • isEnableSecureBoot

        public Boolean isEnableSecureBoot()
        Gets the enableSecureBoot. Indicates whether secure boot is enabled for this virtual server instance.
        Returns:
        the enableSecureBoot

      • getGpu

        public InstanceGPU getGpu()
        Gets the gpu. The virtual server instance GPU configuration.
        Returns:
        the gpu

      • getHealthReasons

        public List<InstanceHealthReason> getHealthReasons()
        Gets the healthReasons. The reasons for the current `health_state` (if any).
        Returns:
        the healthReasons

      • getHealthState

        public String getHealthState()
        Gets the healthState. The health of this resource: - `ok`: No abnormal behavior detected - `degraded`: Experiencing compromised performance, capacity, or connectivity - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.
        Returns:
        the healthState

      • getHref

        public String getHref()
        Gets the href. The URL for this virtual server instance.
        Returns:
        the href

      • getId

        public String getId()
        Gets the id. The unique identifier for this virtual server instance.
        Returns:
        the id

      • getImage

        public ImageReference getImage()
        Gets the image. The image the virtual server instance was provisioned from.
        Returns:
        the image

      • getLifecycleReasons

        public List<InstanceLifecycleReason> getLifecycleReasons()
        Gets the lifecycleReasons. The reasons for the current `lifecycle_state` (if any).
        Returns:
        the lifecycleReasons

      • getLifecycleState

        public String getLifecycleState()
        Gets the lifecycleState. The lifecycle state of the virtual server instance.
        Returns:
        the lifecycleState

      • getMemory

        public Long getMemory()
        Gets the memory. The amount of memory, truncated to whole gibibytes. The maximum limit for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
        Returns:
        the memory

      • getMetadataService

        public InstanceMetadataService getMetadataService()
        Gets the metadataService. The metadata service configuration.
        Returns:
        the metadataService

      • getName

        public String getName()
        Gets the name. The name for this virtual server instance. The name is unique across all virtual server instances in the region.
        Returns:
        the name

      • getNetworkAttachments

        public List<InstanceNetworkAttachmentReference> getNetworkAttachments()
        Gets the networkAttachments. The network attachments for this virtual server instance, including the primary network attachment.
        Returns:
        the networkAttachments

      • getNetworkInterfaces

        public List<NetworkInterfaceInstanceContextReference> getNetworkInterfaces()
        Gets the networkInterfaces. The network interfaces for this instance, including the primary network interface. If this instance has network attachments, each network interface is a [read-only representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its corresponding network attachment and its attached virtual network interface.
        Returns:
        the networkInterfaces

      • getNumaCount

        public Long getNumaCount()
        Gets the numaCount. The number of NUMA nodes this virtual server instance is provisioned on. This property will be absent if the instance's `status` is not `running`.
        Returns:
        the numaCount

      • getPlacementTarget

        public InstancePlacementTarget getPlacementTarget()
        Gets the placementTarget. The placement restrictions for the virtual server instance.
        Returns:
        the placementTarget

      • getPrimaryNetworkAttachment

        public InstanceNetworkAttachmentReference getPrimaryNetworkAttachment()
        Gets the primaryNetworkAttachment. The primary network attachment for this virtual server instance.
        Returns:
        the primaryNetworkAttachment

      • getPrimaryNetworkInterface

        public NetworkInterfaceInstanceContextReference getPrimaryNetworkInterface()
        Gets the primaryNetworkInterface. The primary network interface for this virtual server instance. If this instance has network attachments, this primary network interface is a [read-only representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of the primary network attachment and its attached virtual network interface.
        Returns:
        the primaryNetworkInterface

      • getProfile

        public InstanceProfileReference getProfile()
        Gets the profile. The [profile](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) for this virtual server instance.
        Returns:
        the profile

      • getReservation

        public ReservationReference getReservation()
        Gets the reservation. The reservation used by this virtual server instance. If absent, no reservation is in use.
        Returns:
        the reservation

      • getReservationAffinity

        public InstanceReservationAffinity getReservationAffinity()
        Gets the reservationAffinity.
        Returns:
        the reservationAffinity

      • getResourceGroup

        public ResourceGroupReference getResourceGroup()
        Gets the resourceGroup. The resource group for this instance.
        Returns:
        the resourceGroup

      • getResourceType

        public String getResourceType()
        Gets the resourceType. The resource type.
        Returns:
        the resourceType

      • isStartable

        public Boolean isStartable()
        Gets the startable. Indicates whether the state of the virtual server instance permits a start request.
        Returns:
        the startable

      • getStatus

        public String getStatus()
        Gets the status. The status of the virtual server instance. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
        Returns:
        the status

      • getStatusReasons

        public List<InstanceStatusReason> getStatusReasons()
        Gets the statusReasons. The reasons for the current status (if any).
        Returns:
        the statusReasons

      • getTotalNetworkBandwidth

        public Long getTotalNetworkBandwidth()
        Gets the totalNetworkBandwidth. The amount of bandwidth (in megabits per second) allocated exclusively to instance network attachments or instance network interfaces.
        Returns:
        the totalNetworkBandwidth

      • getTotalVolumeBandwidth

        public Long getTotalVolumeBandwidth()
        Gets the totalVolumeBandwidth. The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in this value will result in a corresponding decrease to `total_network_bandwidth`.
        Returns:
        the totalVolumeBandwidth

      • getVcpu

        public InstanceVCPU getVcpu()
        Gets the vcpu. The virtual server instance VCPU configuration.
        Returns:
        the vcpu

      • getVolumeAttachments

        public List<VolumeAttachmentReferenceInstanceContext> getVolumeAttachments()
        Gets the volumeAttachments. The volume attachments for this virtual server instance, including the boot volume attachment.
        Returns:
        the volumeAttachments

      • getVpc

        public VPCReference getVpc()
        Gets the vpc. The VPC this virtual server instance resides in.
        Returns:
        the vpc

      • getZone

        public ZoneReference getZone()
        Gets the zone. The zone this virtual server instance resides in.
        Returns:
        the zone