1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. MediaServices
  5. getSystemMediaWorkflow
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.MediaServices.getSystemMediaWorkflow

Explore with Pulumi AI

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

    This data source provides details about a specific System Media Workflow resource in Oracle Cloud Infrastructure Media Services service.

    Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testSystemMediaWorkflow = oci.MediaServices.getSystemMediaWorkflow({
        compartmentId: compartmentId,
        name: systemMediaWorkflowName,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_system_media_workflow = oci.MediaServices.get_system_media_workflow(compartment_id=compartment_id,
        name=system_media_workflow_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/MediaServices"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := MediaServices.GetSystemMediaWorkflow(ctx, &mediaservices.GetSystemMediaWorkflowArgs{
    			CompartmentId: pulumi.StringRef(compartmentId),
    			Name:          pulumi.StringRef(systemMediaWorkflowName),
    		}, 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 testSystemMediaWorkflow = Oci.MediaServices.GetSystemMediaWorkflow.Invoke(new()
        {
            CompartmentId = compartmentId,
            Name = systemMediaWorkflowName,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.MediaServices.MediaServicesFunctions;
    import com.pulumi.oci.MediaServices.inputs.GetSystemMediaWorkflowArgs;
    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 testSystemMediaWorkflow = MediaServicesFunctions.getSystemMediaWorkflow(GetSystemMediaWorkflowArgs.builder()
                .compartmentId(compartmentId)
                .name(systemMediaWorkflowName)
                .build());
    
        }
    }
    
    variables:
      testSystemMediaWorkflow:
        fn::invoke:
          Function: oci:MediaServices:getSystemMediaWorkflow
          Arguments:
            compartmentId: ${compartmentId}
            name: ${systemMediaWorkflowName}
    

    Using getSystemMediaWorkflow

    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 getSystemMediaWorkflow(args: GetSystemMediaWorkflowArgs, opts?: InvokeOptions): Promise<GetSystemMediaWorkflowResult>
    function getSystemMediaWorkflowOutput(args: GetSystemMediaWorkflowOutputArgs, opts?: InvokeOptions): Output<GetSystemMediaWorkflowResult>
    def get_system_media_workflow(compartment_id: Optional[str] = None,
                                  name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetSystemMediaWorkflowResult
    def get_system_media_workflow_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                  name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetSystemMediaWorkflowResult]
    func GetSystemMediaWorkflow(ctx *Context, args *GetSystemMediaWorkflowArgs, opts ...InvokeOption) (*GetSystemMediaWorkflowResult, error)
    func GetSystemMediaWorkflowOutput(ctx *Context, args *GetSystemMediaWorkflowOutputArgs, opts ...InvokeOption) GetSystemMediaWorkflowResultOutput

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

    public static class GetSystemMediaWorkflow 
    {
        public static Task<GetSystemMediaWorkflowResult> InvokeAsync(GetSystemMediaWorkflowArgs args, InvokeOptions? opts = null)
        public static Output<GetSystemMediaWorkflowResult> Invoke(GetSystemMediaWorkflowInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSystemMediaWorkflowResult> getSystemMediaWorkflow(GetSystemMediaWorkflowArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:MediaServices/getSystemMediaWorkflow:getSystemMediaWorkflow
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ID of the compartment in which to list resources.
    Name string
    A filter to return only the resources with their system defined, unique name matching the given name.
    CompartmentId string
    The ID of the compartment in which to list resources.
    Name string
    A filter to return only the resources with their system defined, unique name matching the given name.
    compartmentId String
    The ID of the compartment in which to list resources.
    name String
    A filter to return only the resources with their system defined, unique name matching the given name.
    compartmentId string
    The ID of the compartment in which to list resources.
    name string
    A filter to return only the resources with their system defined, unique name matching the given name.
    compartment_id str
    The ID of the compartment in which to list resources.
    name str
    A filter to return only the resources with their system defined, unique name matching the given name.
    compartmentId String
    The ID of the compartment in which to list resources.
    name String
    A filter to return only the resources with their system defined, unique name matching the given name.

    getSystemMediaWorkflow Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetSystemMediaWorkflowItem>
    List of SytemMediaWorkflow items.
    CompartmentId string
    Name string
    System provided unique identifier for this static media workflow.
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetSystemMediaWorkflowItem
    List of SytemMediaWorkflow items.
    CompartmentId string
    Name string
    System provided unique identifier for this static media workflow.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetSystemMediaWorkflowItem>
    List of SytemMediaWorkflow items.
    compartmentId String
    name String
    System provided unique identifier for this static media workflow.
    id string
    The provider-assigned unique ID for this managed resource.
    items GetSystemMediaWorkflowItem[]
    List of SytemMediaWorkflow items.
    compartmentId string
    name string
    System provided unique identifier for this static media workflow.
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[mediaservices.GetSystemMediaWorkflowItem]
    List of SytemMediaWorkflow items.
    compartment_id str
    name str
    System provided unique identifier for this static media workflow.
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    List of SytemMediaWorkflow items.
    compartmentId String
    name String
    System provided unique identifier for this static media workflow.

    Supporting Types

    GetSystemMediaWorkflowItem

    Description string
    Description of this workflow's processing and how that processing can be customized by specifying parameter values.
    Name string
    A filter to return only the resources with their system defined, unique name matching the given name.
    Parameters string
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    Tasks List<GetSystemMediaWorkflowItemTask>
    The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.
    Description string
    Description of this workflow's processing and how that processing can be customized by specifying parameter values.
    Name string
    A filter to return only the resources with their system defined, unique name matching the given name.
    Parameters string
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    Tasks []GetSystemMediaWorkflowItemTask
    The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.
    description String
    Description of this workflow's processing and how that processing can be customized by specifying parameter values.
    name String
    A filter to return only the resources with their system defined, unique name matching the given name.
    parameters String
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    tasks List<GetSystemMediaWorkflowItemTask>
    The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.
    description string
    Description of this workflow's processing and how that processing can be customized by specifying parameter values.
    name string
    A filter to return only the resources with their system defined, unique name matching the given name.
    parameters string
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    tasks GetSystemMediaWorkflowItemTask[]
    The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.
    description str
    Description of this workflow's processing and how that processing can be customized by specifying parameter values.
    name str
    A filter to return only the resources with their system defined, unique name matching the given name.
    parameters str
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    tasks Sequence[mediaservices.GetSystemMediaWorkflowItemTask]
    The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.
    description String
    Description of this workflow's processing and how that processing can be customized by specifying parameter values.
    name String
    A filter to return only the resources with their system defined, unique name matching the given name.
    parameters String
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    tasks List<Property Map>
    The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.

    GetSystemMediaWorkflowItemTask

    EnableParameterReference string
    Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.
    EnableWhenReferencedParameterEquals Dictionary<string, string>
    Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.
    Key string
    A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.
    Parameters string
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    Prerequisites List<string>
    Keys to the other tasks in this workflow that must be completed before execution of this task can begin.
    Type string
    The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration.
    Version string
    The version of the MediaWorkflowTaskDeclaration.
    EnableParameterReference string
    Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.
    EnableWhenReferencedParameterEquals map[string]string
    Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.
    Key string
    A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.
    Parameters string
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    Prerequisites []string
    Keys to the other tasks in this workflow that must be completed before execution of this task can begin.
    Type string
    The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration.
    Version string
    The version of the MediaWorkflowTaskDeclaration.
    enableParameterReference String
    Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.
    enableWhenReferencedParameterEquals Map<String,String>
    Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.
    key String
    A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.
    parameters String
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    prerequisites List<String>
    Keys to the other tasks in this workflow that must be completed before execution of this task can begin.
    type String
    The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration.
    version String
    The version of the MediaWorkflowTaskDeclaration.
    enableParameterReference string
    Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.
    enableWhenReferencedParameterEquals {[key: string]: string}
    Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.
    key string
    A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.
    parameters string
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    prerequisites string[]
    Keys to the other tasks in this workflow that must be completed before execution of this task can begin.
    type string
    The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration.
    version string
    The version of the MediaWorkflowTaskDeclaration.
    enable_parameter_reference str
    Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.
    enable_when_referenced_parameter_equals Mapping[str, str]
    Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.
    key str
    A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.
    parameters str
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    prerequisites Sequence[str]
    Keys to the other tasks in this workflow that must be completed before execution of this task can begin.
    type str
    The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration.
    version str
    The version of the MediaWorkflowTaskDeclaration.
    enableParameterReference String
    Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.
    enableWhenReferencedParameterEquals Map<String>
    Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.
    key String
    A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.
    parameters String
    Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.
    prerequisites List<String>
    Keys to the other tasks in this workflow that must be completed before execution of this task can begin.
    type String
    The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration.
    version String
    The version of the MediaWorkflowTaskDeclaration.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi