Class QueryProperties

The query properties.

Inheritance

object

QueryProperties

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.UsageapiService.Models

Assembly: OCI.DotNetSDK.Usageapi.dll

Syntax

public class QueryProperties

Properties

CompartmentDepth

Declaration

[JsonProperty(PropertyName = "compartmentDepth")]
public decimal? CompartmentDepth { get; set; }

Property Value

Type	Description
decimal?	The depth level of the compartment.

DateRange

Declaration

[Required(ErrorMessage = "DateRange is required.")]
[JsonProperty(PropertyName = "dateRange")]
public DateRange DateRange { get; set; }

Property Value

Type	Description
DateRange

Remarks

Required

Filter

Declaration

[JsonProperty(PropertyName = "filter")]
public Filter Filter { get; set; }

Property Value

Type	Description
Filter

Granularity

Declaration

[Required(ErrorMessage = "Granularity is required.")]
[JsonProperty(PropertyName = "granularity")]
[JsonConverter(typeof(ResponseEnumConverter))]
public QueryProperties.GranularityEnum? Granularity { get; set; }

Property Value

Type	Description
QueryProperties.GranularityEnum?	The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY

Remarks

Required

GroupBy

Declaration

[JsonProperty(PropertyName = "groupBy")]
public List<string> GroupBy { get; set; }

Property Value

Type	Description
List<string>	Aggregate the result by. For Example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]

GroupByTag

Declaration

[JsonProperty(PropertyName = "groupByTag")]
public List<Tag> GroupByTag { get; set; }

Property Value

Type	Description
List<Tag>	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" ]

IsAggregateByTime

Declaration

[JsonProperty(PropertyName = "isAggregateByTime")]
public bool? IsAggregateByTime { get; set; }

Property Value

Type	Description
bool?	Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.

QueryType

Declaration

[JsonProperty(PropertyName = "queryType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public QueryProperties.QueryTypeEnum? QueryType { get; set; }

Property Value

Type	Description
QueryProperties.QueryTypeEnum?	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