Oracle Cloud Infrastructure v2.15.0 published on Thursday, Oct 31, 2024 by Pulumi
oci.MeteringComputation.getSchedule
Explore with Pulumi AI
This data source provides details about a specific Schedule resource in Oracle Cloud Infrastructure Metering Computation service.
Returns the saved schedule.
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:
- Schedule
Id string - The schedule unique OCID.
- Schedule
Id string - The schedule unique OCID.
- schedule
Id String - The schedule unique OCID.
- schedule
Id string - The schedule unique OCID.
- schedule_
id str - The schedule unique OCID.
- schedule
Id String - The schedule unique OCID.
getSchedule Result
The following output properties are available:
- Compartment
Id string - The customer tenancy.
- 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.
- 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.
- Output
File stringFormat - Specifies the supported output file format.
- Query
Properties List<GetSchedule Query Property> - The query properties.
- Result
Locations List<GetSchedule Result Location> - The location where usage or cost CSVs will be uploaded defined by
locationType
, which corresponds with type-specific characteristics. - Saved
Report stringId - The saved report ID which can also be used to generate a query.
- Schedule
Id string - Schedule
Recurrences 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.
- 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"}
- Time
Created string - The date and time the schedule was created.
- Time
Next stringRun - The date and time of the next job execution.
- Time
Scheduled string - The date and time of the first time job execution.
- Compartment
Id string - The customer tenancy.
- 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.
- 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.
- Output
File stringFormat - Specifies the supported output file format.
- Query
Properties []GetSchedule Query Property - The query properties.
- Result
Locations []GetSchedule Result Location - The location where usage or cost CSVs will be uploaded defined by
locationType
, which corresponds with type-specific characteristics. - Saved
Report stringId - The saved report ID which can also be used to generate a query.
- Schedule
Id string - Schedule
Recurrences 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.
- 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"}
- Time
Created string - The date and time the schedule was created.
- Time
Next stringRun - The date and time of the next job execution.
- Time
Scheduled string - The date and time of the first time job execution.
- compartment
Id String - The customer tenancy.
- 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.
- 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.
- output
File StringFormat - Specifies the supported output file format.
- query
Properties List<GetSchedule Query Property> - The query properties.
- result
Locations List<GetSchedule Result Location> - The location where usage or cost CSVs will be uploaded defined by
locationType
, which corresponds with type-specific characteristics. - saved
Report StringId - The saved report ID which can also be used to generate a query.
- schedule
Id String - schedule
Recurrences 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.
- 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"}
- time
Created String - The date and time the schedule was created.
- time
Next StringRun - The date and time of the next job execution.
- time
Scheduled String - The date and time of the first time job execution.
- compartment
Id string - The customer tenancy.
- {[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.
- {[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.
- output
File stringFormat - Specifies the supported output file format.
- query
Properties GetSchedule Query Property[] - The query properties.
- result
Locations GetSchedule Result Location[] - The location where usage or cost CSVs will be uploaded defined by
locationType
, which corresponds with type-specific characteristics. - saved
Report stringId - The saved report ID which can also be used to generate a query.
- schedule
Id string - schedule
Recurrences 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.
- {[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"}
- time
Created string - The date and time the schedule was created.
- time
Next stringRun - The date and time of the next job execution.
- time
Scheduled string - The date and time of the first time job execution.
- compartment_
id str - The customer tenancy.
- 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.
- 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_ strformat - Specifies the supported output file format.
- query_
properties Sequence[meteringcomputation.Get Schedule Query Property] - The query properties.
- result_
locations Sequence[meteringcomputation.Get Schedule Result Location] - The location where usage or cost CSVs will be uploaded defined by
locationType
, which corresponds with type-specific characteristics. - saved_
report_ strid - 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.
- 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_ strrun - The date and time of the next job execution.
- time_
scheduled str - The date and time of the first time job execution.
- compartment
Id String - The customer tenancy.
- 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.
- 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.
- output
File StringFormat - Specifies the supported output file format.
- query
Properties List<Property Map> - The query properties.
- result
Locations List<Property Map> - The location where usage or cost CSVs will be uploaded defined by
locationType
, which corresponds with type-specific characteristics. - saved
Report StringId - The saved report ID which can also be used to generate a query.
- schedule
Id String - schedule
Recurrences 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.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the schedule was created.
- time
Next StringRun - The date and time of the next job execution.
- time
Scheduled String - The date and time of the first time job execution.
Supporting Types
GetScheduleQueryProperty
- Compartment
Depth double - The depth level of the compartment.
- Date
Ranges List<GetSchedule Query Property Date Range> - 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
- Group
Bies List<string> - Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
- List<Get
Schedule Query Property Group By 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" ]
- Is
Aggregate boolBy Time - Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
- Query
Type 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 float64 - The depth level of the compartment.
- Date
Ranges []GetSchedule Query Property Date Range - 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
- Group
Bies []string - Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
- []Get
Schedule Query Property Group By 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" ]
- Is
Aggregate boolBy Time - Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
- Query
Type 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 Double - The depth level of the compartment.
- date
Ranges List<GetSchedule Query Property Date Range> - 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
- group
Bies List<String> - Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
- List<Get
Schedule Query Property Group By 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" ]
- is
Aggregate BooleanBy Time - Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
- query
Type 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 number - The depth level of the compartment.
- date
Ranges GetSchedule Query Property Date Range[] - 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
- group
Bies string[] - Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
- Get
Schedule Query Property Group By 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" ]
- is
Aggregate booleanBy Time - Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
- query
Type 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.Get Schedule Query Property Date Range] - 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" ]
- Sequence[meteringcomputation.
Get Schedule Query Property Group By 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" ]
- is_
aggregate_ boolby_ time - 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
- compartment
Depth Number - The depth level of the compartment.
- date
Ranges 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
- group
Bies List<String> - Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ]
- 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" ]
- is
Aggregate BooleanBy Time - Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up.
- query
Type 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
- Date
Range stringType - Defines whether the schedule date range is STATIC or DYNAMIC.
- Dynamic
Date stringRange Type - Time
Usage stringEnded - The usage end time.
- Time
Usage stringStarted - The usage start time.
- Date
Range stringType - Defines whether the schedule date range is STATIC or DYNAMIC.
- Dynamic
Date stringRange Type - Time
Usage stringEnded - The usage end time.
- Time
Usage stringStarted - The usage start time.
- date
Range StringType - Defines whether the schedule date range is STATIC or DYNAMIC.
- dynamic
Date StringRange Type - time
Usage StringEnded - The usage end time.
- time
Usage StringStarted - The usage start time.
- date
Range stringType - Defines whether the schedule date range is STATIC or DYNAMIC.
- dynamic
Date stringRange Type - time
Usage stringEnded - The usage end time.
- time
Usage stringStarted - The usage start time.
- date_
range_ strtype - Defines whether the schedule date range is STATIC or DYNAMIC.
- dynamic_
date_ strrange_ type - time_
usage_ strended - The usage end time.
- time_
usage_ strstarted - The usage start time.
- date
Range StringType - Defines whether the schedule date range is STATIC or DYNAMIC.
- dynamic
Date StringRange Type - time
Usage StringEnded - The usage end time.
- time
Usage StringStarted - The usage start time.
GetScheduleQueryPropertyGroupByTag
GetScheduleResultLocation
- Bucket string
- The bucket name where usage or cost CSVs will be uploaded.
- Location
Type 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.
- Location
Type 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.
- location
Type 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.
- location
Type 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.
- location
Type 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.