@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 ExplicitlySetBmcModel.__explicitlySet__
. The hashCode()
and
equals(Object)
methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__
into account.
The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the
constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
ReportQuery.Builder |
static class |
ReportQuery.DateRangeName
The UI date range, for example, LAST_THREE_MONTHS.
|
static class |
ReportQuery.Granularity
The usage granularity.
|
static class |
ReportQuery.QueryType
The query usage type.
|
Constructor and Description |
---|
ReportQuery(String tenantId,
Date timeUsageStarted,
Date timeUsageEnded,
ReportQuery.Granularity granularity,
Boolean isAggregateByTime,
Forecast forecast,
ReportQuery.QueryType queryType,
List<String> groupBy,
List<Tag> groupByTag,
BigDecimal compartmentDepth,
Filter filter,
ReportQuery.DateRangeName dateRangeName)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static ReportQuery.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
BigDecimal |
getCompartmentDepth()
The compartment depth level.
|
ReportQuery.DateRangeName |
getDateRangeName()
The UI date range, for example, LAST_THREE_MONTHS.
|
Filter |
getFilter() |
Forecast |
getForecast() |
ReportQuery.Granularity |
getGranularity()
The usage granularity.
|
List<String> |
getGroupBy()
Aggregate the result by.
|
List<Tag> |
getGroupByTag()
GroupBy a specific tagKey.
|
Boolean |
getIsAggregateByTime()
Whether aggregated by time.
|
ReportQuery.QueryType |
getQueryType()
The query usage type.
|
String |
getTenantId()
Tenant ID.
|
Date |
getTimeUsageEnded()
The usage end time.
|
Date |
getTimeUsageStarted()
The usage start time.
|
int |
hashCode() |
ReportQuery.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"tenantId","timeUsageStarted","timeUsageEnded","granularity","isAggregateByTime","forecast","queryType","groupBy","groupByTag","compartmentDepth","filter","dateRangeName"}) public ReportQuery(String tenantId, Date timeUsageStarted, Date timeUsageEnded, ReportQuery.Granularity granularity, Boolean isAggregateByTime, Forecast forecast, ReportQuery.QueryType queryType, List<String> groupBy, List<Tag> groupByTag, BigDecimal compartmentDepth, Filter filter, ReportQuery.DateRangeName dateRangeName)
public static ReportQuery.Builder builder()
Create a new builder.
public ReportQuery.Builder toBuilder()
public String getTenantId()
Tenant ID.
public Date getTimeUsageStarted()
The usage start time.
public Date getTimeUsageEnded()
The usage end time.
public ReportQuery.Granularity getGranularity()
The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.
public Boolean getIsAggregateByTime()
Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.
public Forecast getForecast()
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
public List<String> getGroupBy()
Aggregate the result by. example: ["tagNamespace", "tagKey", "tagValue", "service",
"skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId",
"platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]
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: [{"namespace":"oracle", "key":"createdBy"]}
public BigDecimal getCompartmentDepth()
The compartment depth level.
public Filter getFilter()
public ReportQuery.DateRangeName getDateRangeName()
The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2023. All rights reserved.