Package com.oracle.bmc.ocvp.model

Class Byol

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public final class Byol
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    An Oracle Cloud VMware Solution Bring-Your-Own-License (BYOL), is a permit (entitlement) customer purchased from Broadcom and registered in OCI to install VMware software.
    Note: Objects should always be created or deserialized using the Byol.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 Byol.Builder, which maintain a set of all explicitly set fields called Byol.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 Byol.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        The OCID of the BYOL.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the BYOL.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A descriptive name for the BYOL.
        Returns:
        the value

      • getDescription

        public String getDescription()
        A description of the BYOL.
        Returns:
        the value

      • getLifecycleState

        public Byol.LifecycleState getLifecycleState()
        The current state of the BYOL.
        Returns:
        the value

      • getSoftwareType

        public Byol.SoftwareType getSoftwareType()
        The type of VMware software the BYOL applies to.

        Supported values: - VCF (VMware Cloud Foundation) - VSAN (VMware vSAN) - VDEFEND (VMware vDefend Firewall) - AVI_LOAD_BALANCER (VMware Avi Load Balancer)

        Returns:
        the value

      • getTotalUnits

        public Integer getTotalUnits()
        Total quantity of licensed units for the specified softwareType:

        - VCF, VDEFEND: number of OCPUs - VSAN: storage capacity in TiB (tebibytes) - AVI_LOAD_BALANCER: number of instances

        Returns:
        the value

      • getAvailableUnits

        public Integer getAvailableUnits()
        The quantity of licensed units that not yet allocated to specific region.
        Returns:
        the value

      • getTimeTermStart

        public Date getTimeTermStart()
        The date and time when the BYOL becomes active.

        VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeTermEnd

        public Date getTimeTermEnd()
        The date and time when the BYOL expires and becomes inactive.

        In the format defined byRFC3339.

        Returns:
        the value

      • getEntitlementKey

        public String getEntitlementKey()
        The Broadcom-supplied identifier of a BYOL license.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the BYOL was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the BYOL was updated, in the format defined by RFC3339.
        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

      • 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

      • 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-retain: true}}

        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