Package com.oracle.bmc.usageapi.model

Class ReportQuery

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.usageapi.model.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	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.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReportQuery

@Deprecated
@ConstructorProperties({"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)

Deprecated.

Method Detail

builder

public static ReportQuery.Builder builder()

Create a new builder.

toBuilder

public ReportQuery.Builder toBuilder()

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()

Whether aggregated by time.

If isAggregateByTime is true, all usage/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()

Aggregate the result by.

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