Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.MeteringComputation.getSchedule

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSchedule = oci.MeteringComputation.getSchedule({
    scheduleId: testScheduleOciMeteringComputationSchedule.id,
});

import pulumi
import pulumi_oci as oci

test_schedule = oci.MeteringComputation.get_schedule(schedule_id=test_schedule_oci_metering_computation_schedule["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := MeteringComputation.GetSchedule(ctx, &meteringcomputation.GetScheduleArgs{
			ScheduleId: testScheduleOciMeteringComputationSchedule.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSchedule = Oci.MeteringComputation.GetSchedule.Invoke(new()
    {
        ScheduleId = testScheduleOciMeteringComputationSchedule.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.MeteringComputation.MeteringComputationFunctions;
import com.pulumi.oci.MeteringComputation.inputs.GetScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testSchedule = MeteringComputationFunctions.getSchedule(GetScheduleArgs.builder()
            .scheduleId(testScheduleOciMeteringComputationSchedule.id())
            .build());

    }
}

variables:
  testSchedule:
    fn::invoke:
      Function: oci:MeteringComputation:getSchedule
      Arguments:
        scheduleId: ${testScheduleOciMeteringComputationSchedule.id}

Using getSchedule

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 getSchedule(args: GetScheduleArgs, opts?: InvokeOptions): Promise<GetScheduleResult>
function getScheduleOutput(args: GetScheduleOutputArgs, opts?: InvokeOptions): Output<GetScheduleResult>

def get_schedule(schedule_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetScheduleResult
def get_schedule_output(schedule_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetScheduleResult]

func GetSchedule(ctx *Context, args *GetScheduleArgs, opts ...InvokeOption) (*GetScheduleResult, error)
func GetScheduleOutput(ctx *Context, args *GetScheduleOutputArgs, opts ...InvokeOption) GetScheduleResultOutput

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

public static class GetSchedule 
{
    public static Task<GetScheduleResult> InvokeAsync(GetScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleResult> Invoke(GetScheduleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:MeteringComputation/getSchedule:getSchedule
  arguments:
    # arguments dictionary

The following arguments are supported:

ScheduleId string: The schedule unique OCID.

ScheduleId string: The schedule unique OCID.

scheduleId String: The schedule unique OCID.

scheduleId string: The schedule unique OCID.

schedule_id str: The schedule unique OCID.

scheduleId String: The schedule unique OCID.

getSchedule Result

The following output properties are available:

CompartmentId string: The customer tenancy.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
Description string: The description of the schedule.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
Id string: The OCID representing a unique shedule.
Name string: The unique name of the schedule created by the user.
OutputFileFormat string: Specifies the supported output file format.
QueryProperties List<GetScheduleQueryProperty>: The query properties.
ResultLocations List<GetScheduleResultLocation>: The location where usage or cost CSVs will be uploaded defined by locationType, which corresponds with type-specific characteristics.
SavedReportId string: The saved report ID which can also be used to generate a query.
ScheduleId string
ScheduleRecurrences string: Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
State string: The schedule lifecycle state.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the schedule was created.
TimeNextRun string: The date and time of the next job execution.
TimeScheduled string: The date and time of the first time job execution.

CompartmentId string: The customer tenancy.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
Description string: The description of the schedule.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
Id string: The OCID representing a unique shedule.
Name string: The unique name of the schedule created by the user.
OutputFileFormat string: Specifies the supported output file format.
QueryProperties []GetScheduleQueryProperty: The query properties.
ResultLocations []GetScheduleResultLocation: The location where usage or cost CSVs will be uploaded defined by locationType, which corresponds with type-specific characteristics.
SavedReportId string: The saved report ID which can also be used to generate a query.
ScheduleId string
ScheduleRecurrences string: Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
State string: The schedule lifecycle state.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time the schedule was created.
TimeNextRun string: The date and time of the next job execution.
TimeScheduled string: The date and time of the first time job execution.

compartmentId String: The customer tenancy.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
description String: The description of the schedule.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
id String: The OCID representing a unique shedule.
name String: The unique name of the schedule created by the user.
outputFileFormat String: Specifies the supported output file format.
queryProperties List<GetScheduleQueryProperty>: The query properties.
resultLocations List<GetScheduleResultLocation>: The location where usage or cost CSVs will be uploaded defined by locationType, which corresponds with type-specific characteristics.
savedReportId String: The saved report ID which can also be used to generate a query.
scheduleId String
scheduleRecurrences String: Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
state String: The schedule lifecycle state.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the schedule was created.
timeNextRun String: The date and time of the next job execution.
timeScheduled String: The date and time of the first time job execution.

compartmentId string: The customer tenancy.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
description string: The description of the schedule.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
id string: The OCID representing a unique shedule.
name string: The unique name of the schedule created by the user.
outputFileFormat string: Specifies the supported output file format.
queryProperties GetScheduleQueryProperty[]: The query properties.
resultLocations GetScheduleResultLocation[]: The location where usage or cost CSVs will be uploaded defined by locationType, which corresponds with type-specific characteristics.
savedReportId string: The saved report ID which can also be used to generate a query.
scheduleId string
scheduleRecurrences string: Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
state string: The schedule lifecycle state.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The date and time the schedule was created.
timeNextRun string: The date and time of the next job execution.
timeScheduled string: The date and time of the first time job execution.

compartment_id str: The customer tenancy.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
description str: The description of the schedule.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
id str: The OCID representing a unique shedule.
name str: The unique name of the schedule created by the user.
output_file_format str: Specifies the supported output file format.
query_properties Sequence[meteringcomputation.GetScheduleQueryProperty]: The query properties.
result_locations Sequence[meteringcomputation.GetScheduleResultLocation]: The location where usage or cost CSVs will be uploaded defined by locationType, which corresponds with type-specific characteristics.
saved_report_id str: The saved report ID which can also be used to generate a query.
schedule_id str
schedule_recurrences str: Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
state str: The schedule lifecycle state.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The date and time the schedule was created.
time_next_run str: The date and time of the next job execution.
time_scheduled str: The date and time of the first time job execution.

compartmentId String: The customer tenancy.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"foo-namespace.bar-key": "value"}
description String: The description of the schedule.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {"bar-key": "value"}
id String: The OCID representing a unique shedule.
name String: The unique name of the schedule created by the user.
outputFileFormat String: Specifies the supported output file format.
queryProperties List<Property Map>: The query properties.
resultLocations List<Property Map>: The location where usage or cost CSVs will be uploaded defined by locationType, which corresponds with type-specific characteristics.
savedReportId String: The saved report ID which can also be used to generate a query.
scheduleId String
scheduleRecurrences String: Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
state String: The schedule lifecycle state.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time the schedule was created.
timeNextRun String: The date and time of the next job execution.
timeScheduled String: The date and time of the first time job execution.

Supporting Types

GetScheduleQueryProperty

CompartmentDepth double: The depth level of the compartment.
DateRanges List<GetScheduleQueryPropertyDateRange>: Static or dynamic date range dateRangeType, which corresponds with type-specific characteristics.
Filter string: The filter object for query usage.
Granularity string: The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY
GroupBies List<string>: Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
GroupByTags List<GetScheduleQueryPropertyGroupByTag>: 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: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or 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. Allowed values are: USAGE COST USAGE_AND_COST

CompartmentDepth float64: The depth level of the compartment.
DateRanges []GetScheduleQueryPropertyDateRange: Static or dynamic date range dateRangeType, which corresponds with type-specific characteristics.
Filter string: The filter object for query usage.
Granularity string: The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY
GroupBies []string: Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
GroupByTags []GetScheduleQueryPropertyGroupByTag: 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: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or 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. Allowed values are: USAGE COST USAGE_AND_COST

compartmentDepth Double: The depth level of the compartment.
dateRanges List<GetScheduleQueryPropertyDateRange>: Static or dynamic date range dateRangeType, which corresponds with type-specific characteristics.
filter String: The filter object for query usage.
granularity String: The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY
groupBies List<String>: Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
groupByTags List<GetScheduleQueryPropertyGroupByTag>: 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: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or 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. Allowed values are: USAGE COST USAGE_AND_COST

compartmentDepth number: The depth level of the compartment.
dateRanges GetScheduleQueryPropertyDateRange[]: Static or dynamic date range dateRangeType, which corresponds with type-specific characteristics.
filter string: The filter object for query usage.
granularity string: The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY
groupBies string[]: Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
groupByTags GetScheduleQueryPropertyGroupByTag[]: 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: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or 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. Allowed values are: USAGE COST USAGE_AND_COST

compartment_depth float: The depth level of the compartment.
date_ranges Sequence[meteringcomputation.GetScheduleQueryPropertyDateRange]: Static or dynamic date range dateRangeType, which corresponds with type-specific characteristics.
filter str: The filter object for query usage.
granularity str: The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY
group_bies Sequence[str]: Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
group_by_tags Sequence[meteringcomputation.GetScheduleQueryPropertyGroupByTag]: 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: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or 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. Allowed values are: USAGE COST USAGE_AND_COST

compartmentDepth Number: The depth level of the compartment.
dateRanges List<Property Map>: Static or dynamic date range dateRangeType, which corresponds with type-specific characteristics.
filter String: The filter object for query usage.
granularity String: The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY
groupBies List<String>: Aggregate the result by. For 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: Specifies whether aggregated by time. If isAggregateByTime is true, all usage or 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. Allowed values are: USAGE COST USAGE_AND_COST

GetScheduleQueryPropertyDateRange

DateRangeType string: Defines whether the schedule date range is STATIC or DYNAMIC.
DynamicDateRangeType string
TimeUsageEnded string: The usage end time.
TimeUsageStarted string: The usage start time.

DateRangeType string: Defines whether the schedule date range is STATIC or DYNAMIC.
DynamicDateRangeType string
TimeUsageEnded string: The usage end time.
TimeUsageStarted string: The usage start time.

dateRangeType String: Defines whether the schedule date range is STATIC or DYNAMIC.
dynamicDateRangeType String
timeUsageEnded String: The usage end time.
timeUsageStarted String: The usage start time.

dateRangeType string: Defines whether the schedule date range is STATIC or DYNAMIC.
dynamicDateRangeType string
timeUsageEnded string: The usage end time.
timeUsageStarted string: The usage start time.

date_range_type str: Defines whether the schedule date range is STATIC or DYNAMIC.
dynamic_date_range_type str
time_usage_ended str: The usage end time.
time_usage_started str: The usage start time.

dateRangeType String: Defines whether the schedule date range is STATIC or DYNAMIC.
dynamicDateRangeType String
timeUsageEnded String: The usage end time.
timeUsageStarted String: The usage start time.

GetScheduleQueryPropertyGroupByTag

Key string: The tag key.
Namespace string: The namespace needed to determine the object storage bucket.
Value string: The tag value.

Key string: The tag key.
Namespace string: The namespace needed to determine the object storage bucket.
Value string: The tag value.

key String: The tag key.
namespace String: The namespace needed to determine the object storage bucket.
value String: The tag value.

key string: The tag key.
namespace string: The namespace needed to determine the object storage bucket.
value string: The tag value.

key str: The tag key.
namespace str: The namespace needed to determine the object storage bucket.
value str: The tag value.

key String: The tag key.
namespace String: The namespace needed to determine the object storage bucket.
value String: The tag value.

GetScheduleResultLocation

Bucket string: The bucket name where usage or cost CSVs will be uploaded.
LocationType string: Defines the type of location where the usage or cost CSVs will be stored.
Namespace string: The namespace needed to determine the object storage bucket.
Region string: The destination Object Store Region specified by the customer.

Bucket string: The bucket name where usage or cost CSVs will be uploaded.
LocationType string: Defines the type of location where the usage or cost CSVs will be stored.
Namespace string: The namespace needed to determine the object storage bucket.
Region string: The destination Object Store Region specified by the customer.

bucket String: The bucket name where usage or cost CSVs will be uploaded.
locationType String: Defines the type of location where the usage or cost CSVs will be stored.
namespace String: The namespace needed to determine the object storage bucket.
region String: The destination Object Store Region specified by the customer.

bucket string: The bucket name where usage or cost CSVs will be uploaded.
locationType string: Defines the type of location where the usage or cost CSVs will be stored.
namespace string: The namespace needed to determine the object storage bucket.
region string: The destination Object Store Region specified by the customer.

bucket str: The bucket name where usage or cost CSVs will be uploaded.
location_type str: Defines the type of location where the usage or cost CSVs will be stored.
namespace str: The namespace needed to determine the object storage bucket.
region str: The destination Object Store Region specified by the customer.

bucket String: The bucket name where usage or cost CSVs will be uploaded.
locationType String: Defines the type of location where the usage or cost CSVs will be stored.
namespace String: The namespace needed to determine the object storage bucket.
region String: The destination Object Store Region specified by the customer.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.MeteringComputation.getSchedule

On this page

On this page

Example Usage

Using getSchedule

getSchedule Result

Supporting Types

GetScheduleQueryProperty

GetScheduleQueryPropertyDateRange

GetScheduleQueryPropertyGroupByTag

GetScheduleResultLocation

Package Details

On this page

On this page