Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.LogAnalytics.getNamespaceScheduledTask

This data source provides details about a specific Namespace Scheduled Task resource in Oracle Cloud Infrastructure Log Analytics service.

Get the scheduled task for the specified task identifier.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testNamespaceScheduledTask = Oci.LogAnalytics.GetNamespaceScheduledTask.Invoke(new()
    {
        Namespace = @var.Namespace_scheduled_task_namespace,
        ScheduledTaskId = oci_log_analytics_scheduled_task.Test_scheduled_task.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := LogAnalytics.GetNamespaceScheduledTask(ctx, &loganalytics.GetNamespaceScheduledTaskArgs{
			Namespace:       _var.Namespace_scheduled_task_namespace,
			ScheduledTaskId: oci_log_analytics_scheduled_task.Test_scheduled_task.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.LogAnalytics.LogAnalyticsFunctions;
import com.pulumi.oci.LogAnalytics.inputs.GetNamespaceScheduledTaskArgs;
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 testNamespaceScheduledTask = LogAnalyticsFunctions.getNamespaceScheduledTask(GetNamespaceScheduledTaskArgs.builder()
            .namespace(var_.namespace_scheduled_task_namespace())
            .scheduledTaskId(oci_log_analytics_scheduled_task.test_scheduled_task().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_namespace_scheduled_task = oci.LogAnalytics.get_namespace_scheduled_task(namespace=var["namespace_scheduled_task_namespace"],
    scheduled_task_id=oci_log_analytics_scheduled_task["test_scheduled_task"]["id"])

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

const testNamespaceScheduledTask = oci.LogAnalytics.getNamespaceScheduledTask({
    namespace: _var.namespace_scheduled_task_namespace,
    scheduledTaskId: oci_log_analytics_scheduled_task.test_scheduled_task.id,
});

variables:
  testNamespaceScheduledTask:
    fn::invoke:
      Function: oci:LogAnalytics:getNamespaceScheduledTask
      Arguments:
        namespace: ${var.namespace_scheduled_task_namespace}
        scheduledTaskId: ${oci_log_analytics_scheduled_task.test_scheduled_task.id}

Using getNamespaceScheduledTask

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 getNamespaceScheduledTask(args: GetNamespaceScheduledTaskArgs, opts?: InvokeOptions): Promise<GetNamespaceScheduledTaskResult>
function getNamespaceScheduledTaskOutput(args: GetNamespaceScheduledTaskOutputArgs, opts?: InvokeOptions): Output<GetNamespaceScheduledTaskResult>

def get_namespace_scheduled_task(namespace: Optional[str] = None,
                                 scheduled_task_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetNamespaceScheduledTaskResult
def get_namespace_scheduled_task_output(namespace: Optional[pulumi.Input[str]] = None,
                                 scheduled_task_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetNamespaceScheduledTaskResult]

func GetNamespaceScheduledTask(ctx *Context, args *GetNamespaceScheduledTaskArgs, opts ...InvokeOption) (*GetNamespaceScheduledTaskResult, error)
func GetNamespaceScheduledTaskOutput(ctx *Context, args *GetNamespaceScheduledTaskOutputArgs, opts ...InvokeOption) GetNamespaceScheduledTaskResultOutput

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

public static class GetNamespaceScheduledTask 
{
    public static Task<GetNamespaceScheduledTaskResult> InvokeAsync(GetNamespaceScheduledTaskArgs args, InvokeOptions? opts = null)
    public static Output<GetNamespaceScheduledTaskResult> Invoke(GetNamespaceScheduledTaskInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNamespaceScheduledTaskResult> getNamespaceScheduledTask(GetNamespaceScheduledTaskArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:LogAnalytics/getNamespaceScheduledTask:getNamespaceScheduledTask
  arguments:
    # arguments dictionary

The following arguments are supported:

Namespace string: The Logging Analytics namespace used for the request.
ScheduledTaskId string: Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

Namespace string: The Logging Analytics namespace used for the request.
ScheduledTaskId string: Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

namespace String: The Logging Analytics namespace used for the request.
scheduledTaskId String: Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

namespace string: The Logging Analytics namespace used for the request.
scheduledTaskId string: Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

namespace str: The Logging Analytics namespace used for the request.
scheduled_task_id str: Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

namespace String: The Logging Analytics namespace used for the request.
scheduledTaskId String: Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

getNamespaceScheduledTask Result

The following output properties are available:

Actions List<GetNamespaceScheduledTaskAction>: Action for scheduled task.
CompartmentId string: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.
FreeformTags Dictionary<string, object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the data plane resource.
Kind string
Namespace string
NumOccurrences string: Number of execution occurrences.
SavedSearchId string: The ManagementSavedSearch id [OCID] utilized in the action.
ScheduledTaskId string
Schedules List<GetNamespaceScheduledTaskSchedule>: Schedules.
State string: The current state of the scheduled task.
TaskStatus string: Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND
TaskType string: Task type.
TimeCreated string: The date and time the scheduled task was created, in the format defined by RFC3339.
TimeUpdated string: The date and time the scheduled task was last updated, in the format defined by RFC3339.
WorkRequestId string: most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.

Actions []GetNamespaceScheduledTaskAction: Action for scheduled task.
CompartmentId string: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.
FreeformTags map[string]interface{}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the data plane resource.
Kind string
Namespace string
NumOccurrences string: Number of execution occurrences.
SavedSearchId string: The ManagementSavedSearch id [OCID] utilized in the action.
ScheduledTaskId string
Schedules []GetNamespaceScheduledTaskSchedule: Schedules.
State string: The current state of the scheduled task.
TaskStatus string: Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND
TaskType string: Task type.
TimeCreated string: The date and time the scheduled task was created, in the format defined by RFC3339.
TimeUpdated string: The date and time the scheduled task was last updated, in the format defined by RFC3339.
WorkRequestId string: most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.

actions List<GetNamespaceScheduledTaskAction>: Action for scheduled task.
compartmentId String: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.
freeformTags Map<String,Object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the data plane resource.
kind String
namespace String
numOccurrences String: Number of execution occurrences.
savedSearchId String: The ManagementSavedSearch id [OCID] utilized in the action.
scheduledTaskId String
schedules List<GetNamespaceScheduledTaskSchedule>: Schedules.
state String: The current state of the scheduled task.
taskStatus String: Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND
taskType String: Task type.
timeCreated String: The date and time the scheduled task was created, in the format defined by RFC3339.
timeUpdated String: The date and time the scheduled task was last updated, in the format defined by RFC3339.
workRequestId String: most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.

actions GetNamespaceScheduledTaskAction[]: Action for scheduled task.
compartmentId string: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string: A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.
freeformTags {[key: string]: any}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: The OCID of the data plane resource.
kind string
namespace string
numOccurrences string: Number of execution occurrences.
savedSearchId string: The ManagementSavedSearch id [OCID] utilized in the action.
scheduledTaskId string
schedules GetNamespaceScheduledTaskSchedule[]: Schedules.
state string: The current state of the scheduled task.
taskStatus string: Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND
taskType string: Task type.
timeCreated string: The date and time the scheduled task was created, in the format defined by RFC3339.
timeUpdated string: The date and time the scheduled task was last updated, in the format defined by RFC3339.
workRequestId string: most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.

actions GetNamespaceScheduledTaskAction]: Action for scheduled task.
compartment_id str: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str: A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.
freeform_tags Mapping[str, Any]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: The OCID of the data plane resource.
kind str
namespace str
num_occurrences str: Number of execution occurrences.
saved_search_id str: The ManagementSavedSearch id [OCID] utilized in the action.
scheduled_task_id str
schedules GetNamespaceScheduledTaskSchedule]: Schedules.
state str: The current state of the scheduled task.
task_status str: Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND
task_type str: Task type.
time_created str: The date and time the scheduled task was created, in the format defined by RFC3339.
time_updated str: The date and time the scheduled task was last updated, in the format defined by RFC3339.
work_request_id str: most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.

actions List<Property Map>: Action for scheduled task.
compartmentId String: Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.
freeformTags Map<Any>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the data plane resource.
kind String
namespace String
numOccurrences String: Number of execution occurrences.
savedSearchId String: The ManagementSavedSearch id [OCID] utilized in the action.
scheduledTaskId String
schedules List<Property Map>: Schedules.
state String: The current state of the scheduled task.
taskStatus String: Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND
taskType String: Task type.
timeCreated String: The date and time the scheduled task was created, in the format defined by RFC3339.
timeUpdated String: The date and time the scheduled task was last updated, in the format defined by RFC3339.
workRequestId String: most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.

Supporting Types

GetNamespaceScheduledTaskAction

CompartmentIdInSubtree bool: if true, purge child compartments data
DataType string: the type of the log data to be purged
PurgeCompartmentId string: the compartment OCID under which the data will be purged
PurgeDuration string: The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).
QueryString string: Purge query string.
SavedSearchId string: The ManagementSavedSearch id [OCID] utilized in the action.
Type string: Schedule type discriminator.

CompartmentIdInSubtree bool: if true, purge child compartments data
DataType string: the type of the log data to be purged
PurgeCompartmentId string: the compartment OCID under which the data will be purged
PurgeDuration string: The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).
QueryString string: Purge query string.
SavedSearchId string: The ManagementSavedSearch id [OCID] utilized in the action.
Type string: Schedule type discriminator.

compartmentIdInSubtree Boolean: if true, purge child compartments data
dataType String: the type of the log data to be purged
purgeCompartmentId String: the compartment OCID under which the data will be purged
purgeDuration String: The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).
queryString String: Purge query string.
savedSearchId String: The ManagementSavedSearch id [OCID] utilized in the action.
type String: Schedule type discriminator.

compartmentIdInSubtree boolean: if true, purge child compartments data
dataType string: the type of the log data to be purged
purgeCompartmentId string: the compartment OCID under which the data will be purged
purgeDuration string: The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).
queryString string: Purge query string.
savedSearchId string: The ManagementSavedSearch id [OCID] utilized in the action.
type string: Schedule type discriminator.

compartment_id_in_subtree bool: if true, purge child compartments data
data_type str: the type of the log data to be purged
purge_compartment_id str: the compartment OCID under which the data will be purged
purge_duration str: The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).
query_string str: Purge query string.
saved_search_id str: The ManagementSavedSearch id [OCID] utilized in the action.
type str: Schedule type discriminator.

compartmentIdInSubtree Boolean: if true, purge child compartments data
dataType String: the type of the log data to be purged
purgeCompartmentId String: the compartment OCID under which the data will be purged
purgeDuration String: The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).
queryString String: Purge query string.
savedSearchId String: The ManagementSavedSearch id [OCID] utilized in the action.
type String: Schedule type discriminator.

GetNamespaceScheduledTaskSchedule

Schedules List<GetNamespaceScheduledTaskScheduleSchedule>

Schedules []GetNamespaceScheduledTaskScheduleSchedule

schedules List<GetNamespaceScheduledTaskScheduleSchedule>

schedules GetNamespaceScheduledTaskScheduleSchedule[]

schedules GetNamespaceScheduledTaskScheduleSchedule]

schedules List<Property Map>

GetNamespaceScheduledTaskScheduleSchedule

Expression string: Value in cron format.
MisfirePolicy string: Schedule misfire retry policy.
RecurringInterval string: Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M).
RepeatCount int: Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once.
TimeZone string: Time zone, by default UTC.
Type string: Schedule type discriminator.

Expression string: Value in cron format.
MisfirePolicy string: Schedule misfire retry policy.
RecurringInterval string: Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M).
RepeatCount int: Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once.
TimeZone string: Time zone, by default UTC.
Type string: Schedule type discriminator.

expression String: Value in cron format.
misfirePolicy String: Schedule misfire retry policy.
recurringInterval String: Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M).
repeatCount Integer: Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once.
timeZone String: Time zone, by default UTC.
type String: Schedule type discriminator.

expression string: Value in cron format.
misfirePolicy string: Schedule misfire retry policy.
recurringInterval string: Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M).
repeatCount number: Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once.
timeZone string: Time zone, by default UTC.
type string: Schedule type discriminator.

expression str: Value in cron format.
misfire_policy str: Schedule misfire retry policy.
recurring_interval str: Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M).
repeat_count int: Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once.
time_zone str: Time zone, by default UTC.
type str: Schedule type discriminator.

expression String: Value in cron format.
misfirePolicy String: Schedule misfire retry policy.
recurringInterval String: Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M).
repeatCount Number: Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once.
timeZone String: Time zone, by default UTC.
type String: Schedule type discriminator.

Package Details

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