Package com.oracle.bmc.capacitymanagement.model

Class OccOverviewSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20231107")
public final class OccOverviewSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The overview summary is used to represent an array item that shall be used to represent the overview of the catalog resources along with their corresponding capacity requests.
    Note: Objects should always be created or deserialized using the OccOverviewSummary.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 OccOverviewSummary.Builder, which maintain a set of all explicitly set fields called OccOverviewSummary.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).

    • Constructor Detail

      • OccOverviewSummary

        @Deprecated
@ConstructorProperties({"compartmentId","periodValue","resourceName","totalAvailable","totalDemanded","totalSupplied","totalRejected","totalCancelled","totalUnfulfilled","workloadTypeBreakdownBlob","capacityRequestsBlob","unit"})
public OccOverviewSummary​(String compartmentId,
                          String periodValue,
                          String resourceName,
                          Long totalAvailable,
                          Long totalDemanded,
                          Long totalSupplied,
                          Long totalRejected,
                          Long totalCancelled,
                          Long totalUnfulfilled,
                          String workloadTypeBreakdownBlob,
                          String capacityRequestsBlob,
                          String unit)
        Deprecated.

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment from which the api call is made.

        This will be used for authorizing the request.

        Returns:
        the value

      • getPeriodValue

        public String getPeriodValue()
        The name of the month along with year for which this summary corresponds to.
        Returns:
        the value

      • getResourceName

        public String getResourceName()
        The name of the resource for which we have aggregated the value.
        Returns:
        the value

      • getTotalAvailable

        public Long getTotalAvailable()
        The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.
        Returns:
        the value

      • getTotalDemanded

        public Long getTotalDemanded()
        The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.
        Returns:
        the value

      • getTotalSupplied

        public Long getTotalSupplied()
        The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.
        Returns:
        the value

      • getTotalRejected

        public Long getTotalRejected()
        The quantity of the resource which is rejected by Oracle.
        Returns:
        the value

      • getTotalCancelled

        public Long getTotalCancelled()
        The quantity of the resource which is cancelled by the customer.

        Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.

        Returns:
        the value

      • getTotalUnfulfilled

        public Long getTotalUnfulfilled()
        The quantity of the resource which Oracle was unable to supply.

        For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.

        Returns:
        the value

      • getWorkloadTypeBreakdownBlob

        public String getWorkloadTypeBreakdownBlob()
        A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types
        Returns:
        the value

      • getCapacityRequestsBlob

        public String getCapacityRequestsBlob()
        A raw json blob containing all the capacity requests corresponding to the resource name
        Returns:
        the value

      • getUnit

        public String getUnit()
        The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.
        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