Oracle Cloud Infrastructure

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

getInvokeRuns

This data source provides the list of Invoke Runs in Oracle Cloud Infrastructure Data Flow service.

Lists all runs of an application in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testInvokeRuns = Output.Create(Oci.DataFlow.GetInvokeRuns.InvokeAsync(new Oci.DataFlow.GetInvokeRunsArgs
        {
            CompartmentId = @var.Compartment_id,
            ApplicationId = oci_dataflow_application.Test_application.Id,
            DisplayName = @var.Invoke_run_display_name,
            DisplayNameStartsWith = @var.Invoke_run_display_name_starts_with,
            OwnerPrincipalId = oci_dataflow_owner_principal.Test_owner_principal.Id,
            State = @var.Invoke_run_state,
            TimeCreatedGreaterThan = @var.Invoke_run_time_created_greater_than,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataFlow.GetInvokeRuns(ctx, &dataflow.GetInvokeRunsArgs{
			CompartmentId:          _var.Compartment_id,
			ApplicationId:          pulumi.StringRef(oci_dataflow_application.Test_application.Id),
			DisplayName:            pulumi.StringRef(_var.Invoke_run_display_name),
			DisplayNameStartsWith:  pulumi.StringRef(_var.Invoke_run_display_name_starts_with),
			OwnerPrincipalId:       pulumi.StringRef(oci_dataflow_owner_principal.Test_owner_principal.Id),
			State:                  pulumi.StringRef(_var.Invoke_run_state),
			TimeCreatedGreaterThan: pulumi.StringRef(_var.Invoke_run_time_created_greater_than),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_invoke_runs = oci.DataFlow.get_invoke_runs(compartment_id=var["compartment_id"],
    application_id=oci_dataflow_application["test_application"]["id"],
    display_name=var["invoke_run_display_name"],
    display_name_starts_with=var["invoke_run_display_name_starts_with"],
    owner_principal_id=oci_dataflow_owner_principal["test_owner_principal"]["id"],
    state=var["invoke_run_state"],
    time_created_greater_than=var["invoke_run_time_created_greater_than"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testInvokeRuns = oci.DataFlow.getInvokeRuns({
    compartmentId: _var.compartment_id,
    applicationId: oci_dataflow_application.test_application.id,
    displayName: _var.invoke_run_display_name,
    displayNameStartsWith: _var.invoke_run_display_name_starts_with,
    ownerPrincipalId: oci_dataflow_owner_principal.test_owner_principal.id,
    state: _var.invoke_run_state,
    timeCreatedGreaterThan: _var.invoke_run_time_created_greater_than,
});

Coming soon!

Using getInvokeRuns

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 getInvokeRuns(args: GetInvokeRunsArgs, opts?: InvokeOptions): Promise<GetInvokeRunsResult>
function getInvokeRunsOutput(args: GetInvokeRunsOutputArgs, opts?: InvokeOptions): Output<GetInvokeRunsResult>
def get_invoke_runs(application_id: Optional[str] = None,
                    compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    display_name_starts_with: Optional[str] = None,
                    filters: Optional[Sequence[_dataflow.GetInvokeRunsFilter]] = None,
                    owner_principal_id: Optional[str] = None,
                    state: Optional[str] = None,
                    time_created_greater_than: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetInvokeRunsResult
def get_invoke_runs_output(application_id: Optional[pulumi.Input[str]] = None,
                    compartment_id: Optional[pulumi.Input[str]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    display_name_starts_with: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[_dataflow.GetInvokeRunsFilterArgs]]]] = None,
                    owner_principal_id: Optional[pulumi.Input[str]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    time_created_greater_than: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetInvokeRunsResult]
func GetInvokeRuns(ctx *Context, args *GetInvokeRunsArgs, opts ...InvokeOption) (*GetInvokeRunsResult, error)
func GetInvokeRunsOutput(ctx *Context, args *GetInvokeRunsOutputArgs, opts ...InvokeOption) GetInvokeRunsResultOutput

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

public static class GetInvokeRuns 
{
    public static Task<GetInvokeRunsResult> InvokeAsync(GetInvokeRunsArgs args, InvokeOptions? opts = null)
    public static Output<GetInvokeRunsResult> Invoke(GetInvokeRunsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInvokeRunsResult> getInvokeRuns(GetInvokeRunsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataFlow/getInvokeRuns:getInvokeRuns
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment.

ApplicationId string

The ID of the application.

DisplayName string

The query parameter for the Spark application name.

DisplayNameStartsWith string

The displayName prefix.

Filters List<GetInvokeRunsFilter>
OwnerPrincipalId string

The OCID of the user who created the resource.

State string

The LifecycleState of the run.

TimeCreatedGreaterThan string

The epoch time that the resource was created.

CompartmentId string

The OCID of the compartment.

ApplicationId string

The ID of the application.

DisplayName string

The query parameter for the Spark application name.

DisplayNameStartsWith string

The displayName prefix.

Filters []GetInvokeRunsFilter
OwnerPrincipalId string

The OCID of the user who created the resource.

State string

The LifecycleState of the run.

TimeCreatedGreaterThan string

The epoch time that the resource was created.

compartmentId String

The OCID of the compartment.

applicationId String

The ID of the application.

displayName String

The query parameter for the Spark application name.

displayNameStartsWith String

The displayName prefix.

filters List<GetInvokeRunsFilter>
ownerPrincipalId String

The OCID of the user who created the resource.

state String

The LifecycleState of the run.

timeCreatedGreaterThan String

The epoch time that the resource was created.

compartmentId string

The OCID of the compartment.

applicationId string

The ID of the application.

displayName string

The query parameter for the Spark application name.

displayNameStartsWith string

The displayName prefix.

filters GetInvokeRunsFilter[]
ownerPrincipalId string

The OCID of the user who created the resource.

state string

The LifecycleState of the run.

timeCreatedGreaterThan string

The epoch time that the resource was created.

compartment_id str

The OCID of the compartment.

application_id str

The ID of the application.

display_name str

The query parameter for the Spark application name.

display_name_starts_with str

The displayName prefix.

filters GetInvokeRunsFilter]
owner_principal_id str

The OCID of the user who created the resource.

state str

The LifecycleState of the run.

time_created_greater_than str

The epoch time that the resource was created.

compartmentId String

The OCID of the compartment.

applicationId String

The ID of the application.

displayName String

The query parameter for the Spark application name.

displayNameStartsWith String

The displayName prefix.

filters List<Property Map>
ownerPrincipalId String

The OCID of the user who created the resource.

state String

The LifecycleState of the run.

timeCreatedGreaterThan String

The epoch time that the resource was created.

getInvokeRuns Result

The following output properties are available:

CompartmentId string

The OCID of a compartment.

Id string

The provider-assigned unique ID for this managed resource.

Runs List<GetInvokeRunsRun>

The list of runs.

ApplicationId string

The application ID.

DisplayName string

A user-friendly name. This name is not necessarily unique.

DisplayNameStartsWith string
Filters List<GetInvokeRunsFilter>
OwnerPrincipalId string

The OCID of the user who created the resource.

State string

The current state of this run.

TimeCreatedGreaterThan string
CompartmentId string

The OCID of a compartment.

Id string

The provider-assigned unique ID for this managed resource.

Runs []GetInvokeRunsRun

The list of runs.

ApplicationId string

The application ID.

DisplayName string

A user-friendly name. This name is not necessarily unique.

DisplayNameStartsWith string
Filters []GetInvokeRunsFilter
OwnerPrincipalId string

The OCID of the user who created the resource.

State string

The current state of this run.

TimeCreatedGreaterThan string
compartmentId String

The OCID of a compartment.

id String

The provider-assigned unique ID for this managed resource.

runs List<GetInvokeRunsRun>

The list of runs.

applicationId String

The application ID.

displayName String

A user-friendly name. This name is not necessarily unique.

displayNameStartsWith String
filters List<GetInvokeRunsFilter>
ownerPrincipalId String

The OCID of the user who created the resource.

state String

The current state of this run.

timeCreatedGreaterThan String
compartmentId string

The OCID of a compartment.

id string

The provider-assigned unique ID for this managed resource.

runs GetInvokeRunsRun[]

The list of runs.

applicationId string

The application ID.

displayName string

A user-friendly name. This name is not necessarily unique.

displayNameStartsWith string
filters GetInvokeRunsFilter[]
ownerPrincipalId string

The OCID of the user who created the resource.

state string

The current state of this run.

timeCreatedGreaterThan string
compartment_id str

The OCID of a compartment.

id str

The provider-assigned unique ID for this managed resource.

runs GetInvokeRunsRun]

The list of runs.

application_id str

The application ID.

display_name str

A user-friendly name. This name is not necessarily unique.

display_name_starts_with str
filters GetInvokeRunsFilter]
owner_principal_id str

The OCID of the user who created the resource.

state str

The current state of this run.

time_created_greater_than str
compartmentId String

The OCID of a compartment.

id String

The provider-assigned unique ID for this managed resource.

runs List<Property Map>

The list of runs.

applicationId String

The application ID.

displayName String

A user-friendly name. This name is not necessarily unique.

displayNameStartsWith String
filters List<Property Map>
ownerPrincipalId String

The OCID of the user who created the resource.

state String

The current state of this run.

timeCreatedGreaterThan String

Supporting Types

GetInvokeRunsFilter

Name string

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

Values List<string>
Regex bool
Name string

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

Values []string
Regex bool
name String

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

values List<String>
regex Boolean
name string

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

values string[]
regex boolean
name str

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

values Sequence[str]
regex bool
name String

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

values List<String>
regex Boolean

GetInvokeRunsRun

ApplicationId string

The ID of the application.

ArchiveUri string

An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

Arguments List<string>

The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as Service Api Spec, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"

Asynchronous bool
ClassName string

The class for the application.

CompartmentId string

The OCID of the compartment.

Configuration Dictionary<string, object>

The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

DataReadInBytes string

The data read by the run in bytes.

DataWrittenInBytes string

The data written by the run in bytes.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

The query parameter for the Spark application name.

DriverShape string

The VM shape for the driver. Sets the driver cores and memory.

Execute string

The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include --class, --file, --jars, --conf, --py-files, and main application file with arguments. Example: --jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.

ExecutorShape string

The VM shape for the executors. Sets the executor cores and memory.

FileUri string

An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The ID of a run.

Language string

The Spark language.

LifecycleDetails string

The detailed messages about the lifecycle state.

LogsBucketUri string

An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

MetastoreId string

The OCID of Oracle Cloud Infrastructure Hive Metastore.

NumExecutors int

The number of executor VMs requested.

OpcRequestId string

Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

OwnerPrincipalId string

The OCID of the user who created the resource.

OwnerUserName string

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

Parameters List<GetInvokeRunsRunParameter>

An array of name/value pairs used to fill placeholders found in properties like Application.arguments. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]

PrivateEndpointDnsZones List<string>

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

PrivateEndpointId string

The OCID of a private endpoint.

PrivateEndpointMaxHostCount int

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

PrivateEndpointNsgIds List<string>

An array of network security group OCIDs.

PrivateEndpointSubnetId string

The OCID of a subnet.

RunDurationInMilliseconds string

The duration of the run in milliseconds.

SparkVersion string

The Spark version utilized to run the application.

State string

The LifecycleState of the run.

TimeCreated string

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

TimeUpdated string

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

TotalOcpu int

The total number of oCPU requested by the run.

Type string

The Spark application processing type.

WarehouseBucketUri string

An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

ApplicationId string

The ID of the application.

ArchiveUri string

An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

Arguments []string

The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as Service Api Spec, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"

Asynchronous bool
ClassName string

The class for the application.

CompartmentId string

The OCID of the compartment.

Configuration map[string]interface{}

The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

DataReadInBytes string

The data read by the run in bytes.

DataWrittenInBytes string

The data written by the run in bytes.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

The query parameter for the Spark application name.

DriverShape string

The VM shape for the driver. Sets the driver cores and memory.

Execute string

The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include --class, --file, --jars, --conf, --py-files, and main application file with arguments. Example: --jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.

ExecutorShape string

The VM shape for the executors. Sets the executor cores and memory.

FileUri string

An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The ID of a run.

Language string

The Spark language.

LifecycleDetails string

The detailed messages about the lifecycle state.

LogsBucketUri string

An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

MetastoreId string

The OCID of Oracle Cloud Infrastructure Hive Metastore.

NumExecutors int

The number of executor VMs requested.

OpcRequestId string

Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

OwnerPrincipalId string

The OCID of the user who created the resource.

OwnerUserName string

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

Parameters []GetInvokeRunsRunParameter

An array of name/value pairs used to fill placeholders found in properties like Application.arguments. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]

PrivateEndpointDnsZones []string

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

PrivateEndpointId string

The OCID of a private endpoint.

PrivateEndpointMaxHostCount int

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

PrivateEndpointNsgIds []string

An array of network security group OCIDs.

PrivateEndpointSubnetId string

The OCID of a subnet.

RunDurationInMilliseconds string

The duration of the run in milliseconds.

SparkVersion string

The Spark version utilized to run the application.

State string

The LifecycleState of the run.

TimeCreated string

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

TimeUpdated string

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

TotalOcpu int

The total number of oCPU requested by the run.

Type string

The Spark application processing type.

WarehouseBucketUri string

An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

applicationId String

The ID of the application.

archiveUri String

An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

arguments List<String>

The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as Service Api Spec, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"

asynchronous Boolean
className String

The class for the application.

compartmentId String

The OCID of the compartment.

configuration Map<String,Object>

The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

dataReadInBytes String

The data read by the run in bytes.

dataWrittenInBytes String

The data written by the run in bytes.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

The query parameter for the Spark application name.

driverShape String

The VM shape for the driver. Sets the driver cores and memory.

execute String

The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include --class, --file, --jars, --conf, --py-files, and main application file with arguments. Example: --jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.

executorShape String

The VM shape for the executors. Sets the executor cores and memory.

fileUri String

An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The ID of a run.

language String

The Spark language.

lifecycleDetails String

The detailed messages about the lifecycle state.

logsBucketUri String

An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

metastoreId String

The OCID of Oracle Cloud Infrastructure Hive Metastore.

numExecutors Integer

The number of executor VMs requested.

opcRequestId String

Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

ownerPrincipalId String

The OCID of the user who created the resource.

ownerUserName String

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

parameters List<GetInvokeRunsRunParameter>

An array of name/value pairs used to fill placeholders found in properties like Application.arguments. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]

privateEndpointDnsZones List<String>

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

privateEndpointId String

The OCID of a private endpoint.

privateEndpointMaxHostCount Integer

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

privateEndpointNsgIds List<String>

An array of network security group OCIDs.

privateEndpointSubnetId String

The OCID of a subnet.

runDurationInMilliseconds String

The duration of the run in milliseconds.

sparkVersion String

The Spark version utilized to run the application.

state String

The LifecycleState of the run.

timeCreated String

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

timeUpdated String

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

totalOcpu Integer

The total number of oCPU requested by the run.

type String

The Spark application processing type.

warehouseBucketUri String

An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

applicationId string

The ID of the application.

archiveUri string

An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

arguments string[]

The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as Service Api Spec, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"

asynchronous boolean
className string

The class for the application.

compartmentId string

The OCID of the compartment.

configuration {[key: string]: any}

The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

dataReadInBytes string

The data read by the run in bytes.

dataWrittenInBytes string

The data written by the run in bytes.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

The query parameter for the Spark application name.

driverShape string

The VM shape for the driver. Sets the driver cores and memory.

execute string

The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include --class, --file, --jars, --conf, --py-files, and main application file with arguments. Example: --jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.

executorShape string

The VM shape for the executors. Sets the executor cores and memory.

fileUri string

An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id string

The ID of a run.

language string

The Spark language.

lifecycleDetails string

The detailed messages about the lifecycle state.

logsBucketUri string

An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

metastoreId string

The OCID of Oracle Cloud Infrastructure Hive Metastore.

numExecutors number

The number of executor VMs requested.

opcRequestId string

Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

ownerPrincipalId string

The OCID of the user who created the resource.

ownerUserName string

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

parameters GetInvokeRunsRunParameter[]

An array of name/value pairs used to fill placeholders found in properties like Application.arguments. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]

privateEndpointDnsZones string[]

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

privateEndpointId string

The OCID of a private endpoint.

privateEndpointMaxHostCount number

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

privateEndpointNsgIds string[]

An array of network security group OCIDs.

privateEndpointSubnetId string

The OCID of a subnet.

runDurationInMilliseconds string

The duration of the run in milliseconds.

sparkVersion string

The Spark version utilized to run the application.

state string

The LifecycleState of the run.

timeCreated string

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

timeUpdated string

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

totalOcpu number

The total number of oCPU requested by the run.

type string

The Spark application processing type.

warehouseBucketUri string

An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

application_id str

The ID of the application.

archive_uri str

An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

arguments Sequence[str]

The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as Service Api Spec, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"

asynchronous bool
class_name str

The class for the application.

compartment_id str

The OCID of the compartment.

configuration Mapping[str, Any]

The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

data_read_in_bytes str

The data read by the run in bytes.

data_written_in_bytes str

The data written by the run in bytes.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

The query parameter for the Spark application name.

driver_shape str

The VM shape for the driver. Sets the driver cores and memory.

execute str

The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include --class, --file, --jars, --conf, --py-files, and main application file with arguments. Example: --jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.

executor_shape str

The VM shape for the executors. Sets the executor cores and memory.

file_uri str

An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id str

The ID of a run.

language str

The Spark language.

lifecycle_details str

The detailed messages about the lifecycle state.

logs_bucket_uri str

An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

metastore_id str

The OCID of Oracle Cloud Infrastructure Hive Metastore.

num_executors int

The number of executor VMs requested.

opc_request_id str

Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

owner_principal_id str

The OCID of the user who created the resource.

owner_user_name str

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

parameters GetInvokeRunsRunParameter]

An array of name/value pairs used to fill placeholders found in properties like Application.arguments. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]

private_endpoint_dns_zones Sequence[str]

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

private_endpoint_id str

The OCID of a private endpoint.

private_endpoint_max_host_count int

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

private_endpoint_nsg_ids Sequence[str]

An array of network security group OCIDs.

private_endpoint_subnet_id str

The OCID of a subnet.

run_duration_in_milliseconds str

The duration of the run in milliseconds.

spark_version str

The Spark version utilized to run the application.

state str

The LifecycleState of the run.

time_created str

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

time_updated str

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

total_ocpu int

The total number of oCPU requested by the run.

type str

The Spark application processing type.

warehouse_bucket_uri str

An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

applicationId String

The ID of the application.

archiveUri String

An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

arguments List<String>

The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as Service Api Spec, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"

asynchronous Boolean
className String

The class for the application.

compartmentId String

The OCID of the compartment.

configuration Map<Any>

The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

dataReadInBytes String

The data read by the run in bytes.

dataWrittenInBytes String

The data written by the run in bytes.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

The query parameter for the Spark application name.

driverShape String

The VM shape for the driver. Sets the driver cores and memory.

execute String

The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include --class, --file, --jars, --conf, --py-files, and main application file with arguments. Example: --jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.

executorShape String

The VM shape for the executors. Sets the executor cores and memory.

fileUri String

An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The ID of a run.

language String

The Spark language.

lifecycleDetails String

The detailed messages about the lifecycle state.

logsBucketUri String

An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

metastoreId String

The OCID of Oracle Cloud Infrastructure Hive Metastore.

numExecutors Number

The number of executor VMs requested.

opcRequestId String

Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

ownerPrincipalId String

The OCID of the user who created the resource.

ownerUserName String

The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

parameters List<Property Map>

An array of name/value pairs used to fill placeholders found in properties like Application.arguments. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]

privateEndpointDnsZones List<String>

An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]

privateEndpointId String

The OCID of a private endpoint.

privateEndpointMaxHostCount Number

The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

privateEndpointNsgIds List<String>

An array of network security group OCIDs.

privateEndpointSubnetId String

The OCID of a subnet.

runDurationInMilliseconds String

The duration of the run in milliseconds.

sparkVersion String

The Spark version utilized to run the application.

state String

The LifecycleState of the run.

timeCreated String

The date and time a application was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

timeUpdated String

The date and time a application was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

totalOcpu Number

The total number of oCPU requested by the run.

type String

The Spark application processing type.

warehouseBucketUri String

An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

GetInvokeRunsRunParameter

Name string

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

Value string

The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

Name string

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

Value string

The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

name String

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

value String

The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

name string

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

value string

The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

name str

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

value str

The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

name String

The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"

value String

The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

Package Details

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

This Pulumi package is based on the oci Terraform Provider.