Package com.oracle.bmc.core.model

Class Shape

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Shape
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A compute instance shape that can be used in launchInstance.

    For more information, see Overview of the Compute Service and Compute Shapes.
    Note: Objects should always be created or deserialized using the Shape.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 Shape.Builder, which maintain a set of all explicitly set fields called Shape.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

      • builder

        public static Shape.Builder builder()
        Create a new builder.

      • getBaselineOcpuUtilizations

        public List<Shape.BaselineOcpuUtilizations> getBaselineOcpuUtilizations()
        For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape.
        Returns:
        the value

      • getMinTotalBaselineOcpusRequired

        public BigDecimal getMinTotalBaselineOcpusRequired()
        For a subcore burstable VM, the minimum total baseline OCPUs required.

        The total baseline OCPUs is equal to baselineOcpuUtilization chosen multiplied by the number of OCPUs chosen.

        Returns:
        the value

      • getShape

        public String getShape()
        The name of the shape.

        You can enumerate all available shapes by calling listShapes.

        Returns:
        the value

      • getProcessorDescription

        public String getProcessorDescription()
        A short description of the shape’s processor (CPU).
        Returns:
        the value

      • getOcpus

        public Float getOcpus()
        The default number of OCPUs available for this shape.
        Returns:
        the value

      • getMemoryInGBs

        public Float getMemoryInGBs()
        The default amount of memory available for this shape, in gigabytes.
        Returns:
        the value

      • getNetworkPorts

        public Integer getNetworkPorts()
        The number of physical network interface card (NIC) ports available for this shape.
        Returns:
        the value

      • getNetworkingBandwidthInGbps

        public Float getNetworkingBandwidthInGbps()
        The networking bandwidth available for this shape, in gigabits per second.
        Returns:
        the value

      • getMaxVnicAttachments

        public Integer getMaxVnicAttachments()
        The maximum number of VNIC attachments available for this shape.
        Returns:
        the value

      • getGpus

        public Integer getGpus()
        The number of GPUs available for this shape.
        Returns:
        the value

      • getGpuDescription

        public String getGpuDescription()
        A short description of the graphics processing unit (GPU) available for this shape.

        If the shape does not have any GPUs, this field is null.

        Returns:
        the value

      • getLocalDisks

        public Integer getLocalDisks()
        The number of local disks available for this shape.
        Returns:
        the value

      • getLocalDisksTotalSizeInGBs

        public Float getLocalDisksTotalSizeInGBs()
        The aggregate size of the local disks available for this shape, in gigabytes.

        If the shape does not have any local disks, this field is null.

        Returns:
        the value

      • getLocalDiskDescription

        public String getLocalDiskDescription()
        A short description of the local disks available for this shape.

        If the shape does not have any local disks, this field is null.

        Returns:
        the value

      • getRdmaPorts

        public Integer getRdmaPorts()
        The number of networking ports available for the remote direct memory access (RDMA) network between nodes in a high performance computing (HPC) cluster network.

        If the shape does not support cluster networks, this value is 0.

        Returns:
        the value

      • getRdmaBandwidthInGbps

        public Integer getRdmaBandwidthInGbps()
        The networking bandwidth available for the remote direct memory access (RDMA) network for this shape, in gigabits per second.
        Returns:
        the value

      • getIsLiveMigrationSupported

        public Boolean getIsLiveMigrationSupported()
        Whether live migration is supported for this shape.
        Returns:
        the value

      • getIsBilledForStoppedInstance

        public Boolean getIsBilledForStoppedInstance()
        Whether billing continues when the instances that use this shape are in the stopped state.
        Returns:
        the value

      • getBillingType

        public Shape.BillingType getBillingType()
        How instances that use this shape are charged.
        Returns:
        the value

      • getQuotaNames

        public List<String> getQuotaNames()
        The list of of compartment quotas for the shape.
        Returns:
        the value

      • getIsSubcore

        public Boolean getIsSubcore()
        Whether the shape supports creating subcore or burstable instances.

        A burstable instance is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional spikes in usage.

        Returns:
        the value

      • getIsFlexible

        public Boolean getIsFlexible()
        Whether the shape supports creating flexible instances.

        A flexible shape is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance.

        Returns:
        the value

      • getResizeCompatibleShapes

        public List<String> getResizeCompatibleShapes()
        The list of compatible shapes that this shape can be changed to.

        For more information, see Changing the Shape of an Instance.

        Returns:
        the value

      • getRecommendedAlternatives

        public List<ShapeAlternativeObject> getRecommendedAlternatives()
        The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape.
        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