Package com.oracle.bmc.usageapi.model

Class QueryProperties

java.lang.Object

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

com.oracle.bmc.usageapi.model.QueryProperties

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200107")
public final class QueryProperties
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The query properties.
Note: Objects should always be created or deserialized using the QueryProperties.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 QueryProperties.Builder, which maintain a set of all explicitly set fields called QueryProperties.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	QueryProperties.Builder
static class	QueryProperties.Granularity	The usage granularity.
static class	QueryProperties.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
QueryProperties(List<String> groupBy, List<Tag> groupByTag, Filter filter, BigDecimal compartmentDepth, QueryProperties.Granularity granularity, QueryProperties.QueryType queryType, Boolean isAggregateByTime, DateRange dateRange)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static QueryProperties.Builder	builder()	Create a new builder.
boolean	equals(Object o)
BigDecimal	getCompartmentDepth()	The depth level of the compartment.
DateRange	getDateRange()
Filter	getFilter()
QueryProperties.Granularity	getGranularity()	The usage granularity.
List<String>	getGroupBy()	Aggregate the result by.
List<Tag>	getGroupByTag()	GroupBy a specific tagKey.
Boolean	getIsAggregateByTime()	Specifies whether aggregated by time.
QueryProperties.QueryType	getQueryType()	The query usage type.
int	hashCode()
QueryProperties.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

QueryProperties

@Deprecated
@ConstructorProperties({"groupBy","groupByTag","filter","compartmentDepth","granularity","queryType","isAggregateByTime","dateRange"})
public QueryProperties(List<String> groupBy,
                       List<Tag> groupByTag,
                       Filter filter,
                       BigDecimal compartmentDepth,
                       QueryProperties.Granularity granularity,
                       QueryProperties.QueryType queryType,
                       Boolean isAggregateByTime,
                       DateRange dateRange)

Deprecated.

Method Detail

builder

public static QueryProperties.Builder builder()

Create a new builder.

toBuilder

public QueryProperties.Builder toBuilder()

getGroupBy

public List<String> getGroupBy()

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: [ { “namespace”: “oracle”, “key”: “createdBy” ]

Returns:

the value

getFilter

public Filter getFilter()

getCompartmentDepth

public BigDecimal getCompartmentDepth()

The depth level of the compartment.

Returns:

the value

getGranularity

public QueryProperties.Granularity getGranularity()

The usage granularity.

DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY

Returns:

the value

getQueryType

public QueryProperties.QueryType getQueryType()

The query usage type.

COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Allowed values are: USAGE COST USAGE_AND_COST

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

getDateRange

public DateRange getDateRange()

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