Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getQuery

This data source provides details about a specific Query resource in Oracle Cloud Infrastructure Metering Computation service.

Returns the saved query.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testQuery = Output.Create(Oci.MeteringComputation.GetQuery.InvokeAsync(new Oci.MeteringComputation.GetQueryArgs
        {
            QueryId = oci_metering_computation_query.Test_query.Id,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/MeteringComputation"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := MeteringComputation.GetQuery(ctx, &meteringcomputation.GetQueryArgs{
			QueryId: oci_metering_computation_query.Test_query.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_query = oci.MeteringComputation.get_query(query_id=oci_metering_computation_query["test_query"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testQuery = oci.MeteringComputation.getQuery({
    queryId: oci_metering_computation_query.test_query.id,
});

Coming soon!

Using getQuery

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getQuery(args: GetQueryArgs, opts?: InvokeOptions): Promise<GetQueryResult>
function getQueryOutput(args: GetQueryOutputArgs, opts?: InvokeOptions): Output<GetQueryResult>
def get_query(query_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueryResult
def get_query_output(query_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetQueryResult]
func GetQuery(ctx *Context, args *GetQueryArgs, opts ...InvokeOption) (*GetQueryResult, error)
func GetQueryOutput(ctx *Context, args *GetQueryOutputArgs, opts ...InvokeOption) GetQueryResultOutput

> Note: This function is named GetQuery in the Go SDK.

public static class GetQuery 
{
    public static Task<GetQueryResult> InvokeAsync(GetQueryArgs args, InvokeOptions? opts = null)
    public static Output<GetQueryResult> Invoke(GetQueryInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetQueryResult> getQuery(GetQueryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:MeteringComputation/getQuery:getQuery
  Arguments:
    # Arguments dictionary

The following arguments are supported:

QueryId string

The query unique OCID.

QueryId string

The query unique OCID.

queryId String

The query unique OCID.

queryId string

The query unique OCID.

query_id str

The query unique OCID.

queryId String

The query unique OCID.

getQuery Result

The following output properties are available:

CompartmentId string

The compartment OCID.

Id string

The query OCID.

QueryDefinitions List<GetQueryQueryDefinition>

The common fields for queries.

QueryId string
CompartmentId string

The compartment OCID.

Id string

The query OCID.

QueryDefinitions []GetQueryQueryDefinition

The common fields for queries.

QueryId string
compartmentId String

The compartment OCID.

id String

The query OCID.

queryDefinitions List<GetQueryQueryDefinition>

The common fields for queries.

queryId String
compartmentId string

The compartment OCID.

id string

The query OCID.

queryDefinitions GetQueryQueryDefinition[]

The common fields for queries.

queryId string
compartment_id str

The compartment OCID.

id str

The query OCID.

query_definitions GetQueryQueryDefinition]

The common fields for queries.

query_id str
compartmentId String

The compartment OCID.

id String

The query OCID.

queryDefinitions List<Property Map>

The common fields for queries.

queryId String

Supporting Types

GetQueryQueryDefinition

CostAnalysisUis List<GetQueryQueryDefinitionCostAnalysisUi>

The common fields for Cost Analysis UI rendering.

DisplayName string

The query display name. Avoid entering confidential information.

ReportQueries List<GetQueryQueryDefinitionReportQuery>

The request of the generated Cost Analysis report.

Version double

The saved query version.

CostAnalysisUis []GetQueryQueryDefinitionCostAnalysisUi

The common fields for Cost Analysis UI rendering.

DisplayName string

The query display name. Avoid entering confidential information.

ReportQueries []GetQueryQueryDefinitionReportQuery

The request of the generated Cost Analysis report.

Version float64

The saved query version.

costAnalysisUis List<GetQueryQueryDefinitionCostAnalysisUi>

The common fields for Cost Analysis UI rendering.

displayName String

The query display name. Avoid entering confidential information.

reportQueries List<GetQueryQueryDefinitionReportQuery>

The request of the generated Cost Analysis report.

version Double

The saved query version.

costAnalysisUis GetQueryQueryDefinitionCostAnalysisUi[]

The common fields for Cost Analysis UI rendering.

displayName string

The query display name. Avoid entering confidential information.

reportQueries GetQueryQueryDefinitionReportQuery[]

The request of the generated Cost Analysis report.

version number

The saved query version.

cost_analysis_uis GetQueryQueryDefinitionCostAnalysisUi]

The common fields for Cost Analysis UI rendering.

display_name str

The query display name. Avoid entering confidential information.

report_queries GetQueryQueryDefinitionReportQuery]

The request of the generated Cost Analysis report.

version float

The saved query version.

costAnalysisUis List<Property Map>

The common fields for Cost Analysis UI rendering.

displayName String

The query display name. Avoid entering confidential information.

reportQueries List<Property Map>

The request of the generated Cost Analysis report.

version Number

The saved query version.

GetQueryQueryDefinitionCostAnalysisUi

Graph string

The graph type.

IsCumulativeGraph bool

A cumulative graph.

Graph string

The graph type.

IsCumulativeGraph bool

A cumulative graph.

graph String

The graph type.

isCumulativeGraph Boolean

A cumulative graph.

graph string

The graph type.

isCumulativeGraph boolean

A cumulative graph.

graph str

The graph type.

is_cumulative_graph bool

A cumulative graph.

graph String

The graph type.

isCumulativeGraph Boolean

A cumulative graph.

GetQueryQueryDefinitionReportQuery

CompartmentDepth double

The compartment depth level.

DateRangeName string

The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.

Filter string
Forecasts List<GetQueryQueryDefinitionReportQueryForecast>

Forecast configuration of usage/cost.

Granularity string

The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.

GroupBies List<string>

Aggregate the result by. example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]

GroupByTags List<GetQueryQueryDefinitionReportQueryGroupByTag>

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 bool

Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.

QueryType string

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 string

Tenant ID.

TimeUsageEnded string

The usage end time.

TimeUsageStarted string

The usage start time.

CompartmentDepth float64

The compartment depth level.

DateRangeName string

The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.

Filter string
Forecasts []GetQueryQueryDefinitionReportQueryForecast

Forecast configuration of usage/cost.

Granularity string

The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.

GroupBies []string

Aggregate the result by. example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]

GroupByTags []GetQueryQueryDefinitionReportQueryGroupByTag

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 bool

Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.

QueryType string

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 string

Tenant ID.

TimeUsageEnded string

The usage end time.

TimeUsageStarted string

The usage start time.

compartmentDepth Double

The compartment depth level.

dateRangeName String

The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.

filter String
forecasts List<GetQueryQueryDefinitionReportQueryForecast>

Forecast configuration of usage/cost.

granularity String

The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.

groupBies List<String>

Aggregate the result by. example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]

groupByTags List<GetQueryQueryDefinitionReportQueryGroupByTag>

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 Boolean

Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.

queryType String

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 String

Tenant ID.

timeUsageEnded String

The usage end time.

timeUsageStarted String

The usage start time.

compartmentDepth number

The compartment depth level.

dateRangeName string

The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.

filter string
forecasts GetQueryQueryDefinitionReportQueryForecast[]

Forecast configuration of usage/cost.

granularity string

The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.

groupBies string[]

Aggregate the result by. example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]

groupByTags GetQueryQueryDefinitionReportQueryGroupByTag[]

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 boolean

Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.

queryType string

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 string

Tenant ID.

timeUsageEnded string

The usage end time.

timeUsageStarted string

The usage start time.

compartment_depth float

The compartment depth level.

date_range_name str

The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.

filter str
forecasts GetQueryQueryDefinitionReportQueryForecast]

Forecast configuration of usage/cost.

granularity str

The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.

group_bies Sequence[str]

Aggregate the result by. example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]

group_by_tags GetQueryQueryDefinitionReportQueryGroupByTag]

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"]

is_aggregate_by_time bool

Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.

query_type str

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

tenant_id str

Tenant ID.

time_usage_ended str

The usage end time.

time_usage_started str

The usage start time.

compartmentDepth Number

The compartment depth level.

dateRangeName String

The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded.

filter String
forecasts List<Property Map>

Forecast configuration of usage/cost.

granularity String

The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.

groupBies List<String>

Aggregate the result by. example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]

groupByTags List<Property Map>

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 Boolean

Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.

queryType String

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 String

Tenant ID.

timeUsageEnded String

The usage end time.

timeUsageStarted String

The usage start time.

GetQueryQueryDefinitionReportQueryForecast

ForecastType string

BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.

TimeForecastEnded string

The forecast end time.

TimeForecastStarted string

The forecast start time. Defaults to UTC-1 if not specified.

ForecastType string

BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.

TimeForecastEnded string

The forecast end time.

TimeForecastStarted string

The forecast start time. Defaults to UTC-1 if not specified.

forecastType String

BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.

timeForecastEnded String

The forecast end time.

timeForecastStarted String

The forecast start time. Defaults to UTC-1 if not specified.

forecastType string

BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.

timeForecastEnded string

The forecast end time.

timeForecastStarted string

The forecast start time. Defaults to UTC-1 if not specified.

forecast_type str

BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.

time_forecast_ended str

The forecast end time.

time_forecast_started str

The forecast start time. Defaults to UTC-1 if not specified.

forecastType String

BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.

timeForecastEnded String

The forecast end time.

timeForecastStarted String

The forecast start time. Defaults to UTC-1 if not specified.

GetQueryQueryDefinitionReportQueryGroupByTag

Key string

The tag key.

Namespace string

The tag namespace.

Value string

The tag value.

Key string

The tag key.

Namespace string

The tag namespace.

Value string

The tag value.

key String

The tag key.

namespace String

The tag namespace.

value String

The tag value.

key string

The tag key.

namespace string

The tag namespace.

value string

The tag value.

key str

The tag key.

namespace str

The tag namespace.

value str

The tag value.

key String

The tag key.

namespace String

The tag namespace.

value String

The tag value.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.