Package com.oracle.bmc.usageapi.model

Class ReportQuery

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200107")
public final class ReportQuery
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The request of the generated Cost Analysis report.
    Note: Objects should always be created or deserialized using the ReportQuery.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 ReportQuery.Builder, which maintain a set of all explicitly set fields called ReportQuery.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

      • getTenantId

        public String getTenantId()
        Tenant ID.
        Returns:
        the value

      • getTimeUsageStarted

        public Date getTimeUsageStarted()
        The usage start time.
        Returns:
        the value

      • getTimeUsageEnded

        public Date getTimeUsageEnded()
        The usage end time.
        Returns:
        the value

      • getGranularity

        public ReportQuery.Granularity getGranularity()
        The usage granularity.

        HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.

        Returns:
        the value

      • getIsAggregateByTime

        public Boolean getIsAggregateByTime()
        Specifies whether aggregated by time.

        If isAggregateByTime is true, all usage or cost over the query time period will be added up.

        Returns:
        the value

      • getForecast

        public Forecast getForecast()

      • getQueryType

        public ReportQuery.QueryType getQueryType()
        The query usage type.

        COST by default if it is missing. * Usage: Query the usage data. * Cost: Query the cost/billing data. * Credit: Query the credit adjustments data. * ExpiredCredit: Query the expired credits data. * AllCredit: Query the credit adjustments and expired credit.

        Returns:
        the value

      • getGroupBy

        public List<String> getGroupBy()
        Specifies what to aggregate the result by.

        For example: [“tagNamespace”, “tagKey”, “tagValue”, “service”, “skuName”, “skuPartNumber”, “unit”, “compartmentName”, “compartmentPath”, “compartmentId”, “platform”, “region”, “logicalAd”, “resourceId”, “tenantId”, “tenantName”]

        Returns:
        the value

      • getGroupByTag

        public List<Tag> getGroupByTag()
        GroupBy a specific tagKey.

        Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: {@code [{“namespace”:“oracle”, “key”:“createdBy”]}

        Returns:
        the value

      • getCompartmentDepth

        public BigDecimal getCompartmentDepth()
        The compartment depth level.
        Returns:
        the value

      • getFilter

        public Filter getFilter()

      • getDateRangeName

        public ReportQuery.DateRangeName getDateRangeName()
        The UI date range, for example, LAST_THREE_MONTHS.

        Conflicts with timeUsageStarted and timeUsageEnded.

        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