Class ReportQuery
The request of the generated Cost Analysis report.
Inherited Members
Namespace: Oci.UsageapiService.Models
Assembly: OCI.DotNetSDK.Usageapi.dll
Syntax
public class ReportQuery
Properties
CompartmentDepth
Declaration
[JsonProperty(PropertyName = "compartmentDepth")]
public decimal? CompartmentDepth { get; set; }
Property Value
Type | Description |
---|---|
decimal? | The compartment depth level. |
DateRangeName
Declaration
[JsonProperty(PropertyName = "dateRangeName")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ReportQuery.DateRangeNameEnum? DateRangeName { get; set; }
Property Value
Type | Description |
---|---|
ReportQuery.DateRangeNameEnum? | The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. |
Filter
Declaration
[JsonProperty(PropertyName = "filter")]
public Filter Filter { get; set; }
Property Value
Type | Description |
---|---|
Filter |
Forecast
Declaration
[JsonProperty(PropertyName = "forecast")]
public Forecast Forecast { get; set; }
Property Value
Type | Description |
---|---|
Forecast |
Granularity
Declaration
[Required(ErrorMessage = "Granularity is required.")]
[JsonProperty(PropertyName = "granularity")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ReportQuery.GranularityEnum? Granularity { get; set; }
Property Value
Type | Description |
---|---|
ReportQuery.GranularityEnum? | The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported. |
Remarks
Required
GroupBy
Declaration
[JsonProperty(PropertyName = "groupBy")]
public List<string> GroupBy { get; set; }
Property Value
Type | Description |
---|---|
List<string> | Aggregate the result by. 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? | Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up. |
QueryType
Declaration
[JsonProperty(PropertyName = "queryType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ReportQuery.QueryTypeEnum? QueryType { get; set; }
Property Value
Type | Description |
---|---|
ReportQuery.QueryTypeEnum? | 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 |
TenantId
Declaration
[Required(ErrorMessage = "TenantId is required.")]
[JsonProperty(PropertyName = "tenantId")]
public string TenantId { get; set; }
Property Value
Type | Description |
---|---|
string | Tenant ID. |
Remarks
Required
TimeUsageEnded
Declaration
[JsonProperty(PropertyName = "timeUsageEnded")]
public DateTime? TimeUsageEnded { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The usage end time. |
TimeUsageStarted
Declaration
[JsonProperty(PropertyName = "timeUsageStarted")]
public DateTime? TimeUsageStarted { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The usage start time. |