Docs
PackagesOracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
oci.DataFlow.InvokeRun
Explore with Pulumi AI
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
This resource provides the Invoke Run resource in Oracle Cloud Infrastructure Data Flow service.
Creates a run for an application.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testInvokeRun = new oci.dataflow.InvokeRun("test_invoke_run", {
compartmentId: compartmentId,
applicationId: testApplication.id,
applicationLogConfig: {
logGroupId: testLogGroup.id,
logId: testLog.id,
},
archiveUri: invokeRunArchiveUri,
arguments: invokeRunArguments,
configuration: invokeRunConfiguration,
definedTags: {
"Operations.CostCenter": "42",
},
displayName: invokeRunDisplayName,
driverShape: invokeRunDriverShape,
driverShapeConfig: {
memoryInGbs: invokeRunDriverShapeConfigMemoryInGbs,
ocpus: invokeRunDriverShapeConfigOcpus,
},
execute: invokeRunExecute,
executorShape: invokeRunExecutorShape,
executorShapeConfig: {
memoryInGbs: invokeRunExecutorShapeConfigMemoryInGbs,
ocpus: invokeRunExecutorShapeConfigOcpus,
},
freeformTags: {
Department: "Finance",
},
idleTimeoutInMinutes: invokeRunIdleTimeoutInMinutes,
logsBucketUri: invokeRunLogsBucketUri,
maxDurationInMinutes: invokeRunMaxDurationInMinutes,
metastoreId: metastoreId,
numExecutors: invokeRunNumExecutors,
opcParentRptUrl: invokeRunOpcParentRptUrl,
parameters: [{
name: invokeRunParametersName,
value: invokeRunParametersValue,
}],
poolId: testPool.id,
sparkVersion: invokeRunSparkVersion,
type: invokeRunType,
warehouseBucketUri: invokeRunWarehouseBucketUri,
});
import pulumi
import pulumi_oci as oci
test_invoke_run = oci.data_flow.InvokeRun("test_invoke_run",
compartment_id=compartment_id,
application_id=test_application["id"],
application_log_config=oci.data_flow.InvokeRunApplicationLogConfigArgs(
log_group_id=test_log_group["id"],
log_id=test_log["id"],
),
archive_uri=invoke_run_archive_uri,
arguments=invoke_run_arguments,
configuration=invoke_run_configuration,
defined_tags={
"Operations.CostCenter": "42",
},
display_name=invoke_run_display_name,
driver_shape=invoke_run_driver_shape,
driver_shape_config=oci.data_flow.InvokeRunDriverShapeConfigArgs(
memory_in_gbs=invoke_run_driver_shape_config_memory_in_gbs,
ocpus=invoke_run_driver_shape_config_ocpus,
),
execute=invoke_run_execute,
executor_shape=invoke_run_executor_shape,
executor_shape_config=oci.data_flow.InvokeRunExecutorShapeConfigArgs(
memory_in_gbs=invoke_run_executor_shape_config_memory_in_gbs,
ocpus=invoke_run_executor_shape_config_ocpus,
),
freeform_tags={
"Department": "Finance",
},
idle_timeout_in_minutes=invoke_run_idle_timeout_in_minutes,
logs_bucket_uri=invoke_run_logs_bucket_uri,
max_duration_in_minutes=invoke_run_max_duration_in_minutes,
metastore_id=metastore_id,
num_executors=invoke_run_num_executors,
opc_parent_rpt_url=invoke_run_opc_parent_rpt_url,
parameters=[oci.data_flow.InvokeRunParameterArgs(
name=invoke_run_parameters_name,
value=invoke_run_parameters_value,
)],
pool_id=test_pool["id"],
spark_version=invoke_run_spark_version,
type=invoke_run_type,
warehouse_bucket_uri=invoke_run_warehouse_bucket_uri)
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.NewInvokeRun(ctx, "test_invoke_run", &DataFlow.InvokeRunArgs{
CompartmentId: pulumi.Any(compartmentId),
ApplicationId: pulumi.Any(testApplication.Id),
ApplicationLogConfig: &dataflow.InvokeRunApplicationLogConfigArgs{
LogGroupId: pulumi.Any(testLogGroup.Id),
LogId: pulumi.Any(testLog.Id),
},
ArchiveUri: pulumi.Any(invokeRunArchiveUri),
Arguments: pulumi.Any(invokeRunArguments),
Configuration: pulumi.Any(invokeRunConfiguration),
DefinedTags: pulumi.Map{
"Operations.CostCenter": pulumi.Any("42"),
},
DisplayName: pulumi.Any(invokeRunDisplayName),
DriverShape: pulumi.Any(invokeRunDriverShape),
DriverShapeConfig: &dataflow.InvokeRunDriverShapeConfigArgs{
MemoryInGbs: pulumi.Any(invokeRunDriverShapeConfigMemoryInGbs),
Ocpus: pulumi.Any(invokeRunDriverShapeConfigOcpus),
},
Execute: pulumi.Any(invokeRunExecute),
ExecutorShape: pulumi.Any(invokeRunExecutorShape),
ExecutorShapeConfig: &dataflow.InvokeRunExecutorShapeConfigArgs{
MemoryInGbs: pulumi.Any(invokeRunExecutorShapeConfigMemoryInGbs),
Ocpus: pulumi.Any(invokeRunExecutorShapeConfigOcpus),
},
FreeformTags: pulumi.Map{
"Department": pulumi.Any("Finance"),
},
IdleTimeoutInMinutes: pulumi.Any(invokeRunIdleTimeoutInMinutes),
LogsBucketUri: pulumi.Any(invokeRunLogsBucketUri),
MaxDurationInMinutes: pulumi.Any(invokeRunMaxDurationInMinutes),
MetastoreId: pulumi.Any(metastoreId),
NumExecutors: pulumi.Any(invokeRunNumExecutors),
OpcParentRptUrl: pulumi.Any(invokeRunOpcParentRptUrl),
Parameters: dataflow.InvokeRunParameterArray{
&dataflow.InvokeRunParameterArgs{
Name: pulumi.Any(invokeRunParametersName),
Value: pulumi.Any(invokeRunParametersValue),
},
},
PoolId: pulumi.Any(testPool.Id),
SparkVersion: pulumi.Any(invokeRunSparkVersion),
Type: pulumi.Any(invokeRunType),
WarehouseBucketUri: pulumi.Any(invokeRunWarehouseBucketUri),
})
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 testInvokeRun = new Oci.DataFlow.InvokeRun("test_invoke_run", new()
{
CompartmentId = compartmentId,
ApplicationId = testApplication.Id,
ApplicationLogConfig = new Oci.DataFlow.Inputs.InvokeRunApplicationLogConfigArgs
{
LogGroupId = testLogGroup.Id,
LogId = testLog.Id,
},
ArchiveUri = invokeRunArchiveUri,
Arguments = invokeRunArguments,
Configuration = invokeRunConfiguration,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
DisplayName = invokeRunDisplayName,
DriverShape = invokeRunDriverShape,
DriverShapeConfig = new Oci.DataFlow.Inputs.InvokeRunDriverShapeConfigArgs
{
MemoryInGbs = invokeRunDriverShapeConfigMemoryInGbs,
Ocpus = invokeRunDriverShapeConfigOcpus,
},
Execute = invokeRunExecute,
ExecutorShape = invokeRunExecutorShape,
ExecutorShapeConfig = new Oci.DataFlow.Inputs.InvokeRunExecutorShapeConfigArgs
{
MemoryInGbs = invokeRunExecutorShapeConfigMemoryInGbs,
Ocpus = invokeRunExecutorShapeConfigOcpus,
},
FreeformTags =
{
{ "Department", "Finance" },
},
IdleTimeoutInMinutes = invokeRunIdleTimeoutInMinutes,
LogsBucketUri = invokeRunLogsBucketUri,
MaxDurationInMinutes = invokeRunMaxDurationInMinutes,
MetastoreId = metastoreId,
NumExecutors = invokeRunNumExecutors,
OpcParentRptUrl = invokeRunOpcParentRptUrl,
Parameters = new[]
{
new Oci.DataFlow.Inputs.InvokeRunParameterArgs
{
Name = invokeRunParametersName,
Value = invokeRunParametersValue,
},
},
PoolId = testPool.Id,
SparkVersion = invokeRunSparkVersion,
Type = invokeRunType,
WarehouseBucketUri = invokeRunWarehouseBucketUri,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataFlow.InvokeRun;
import com.pulumi.oci.DataFlow.InvokeRunArgs;
import com.pulumi.oci.DataFlow.inputs.InvokeRunApplicationLogConfigArgs;
import com.pulumi.oci.DataFlow.inputs.InvokeRunDriverShapeConfigArgs;
import com.pulumi.oci.DataFlow.inputs.InvokeRunExecutorShapeConfigArgs;
import com.pulumi.oci.DataFlow.inputs.InvokeRunParameterArgs;
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) {
var testInvokeRun = new InvokeRun("testInvokeRun", InvokeRunArgs.builder()
.compartmentId(compartmentId)
.applicationId(testApplication.id())
.applicationLogConfig(InvokeRunApplicationLogConfigArgs.builder()
.logGroupId(testLogGroup.id())
.logId(testLog.id())
.build())
.archiveUri(invokeRunArchiveUri)
.arguments(invokeRunArguments)
.configuration(invokeRunConfiguration)
.definedTags(Map.of("Operations.CostCenter", "42"))
.displayName(invokeRunDisplayName)
.driverShape(invokeRunDriverShape)
.driverShapeConfig(InvokeRunDriverShapeConfigArgs.builder()
.memoryInGbs(invokeRunDriverShapeConfigMemoryInGbs)
.ocpus(invokeRunDriverShapeConfigOcpus)
.build())
.execute(invokeRunExecute)
.executorShape(invokeRunExecutorShape)
.executorShapeConfig(InvokeRunExecutorShapeConfigArgs.builder()
.memoryInGbs(invokeRunExecutorShapeConfigMemoryInGbs)
.ocpus(invokeRunExecutorShapeConfigOcpus)
.build())
.freeformTags(Map.of("Department", "Finance"))
.idleTimeoutInMinutes(invokeRunIdleTimeoutInMinutes)
.logsBucketUri(invokeRunLogsBucketUri)
.maxDurationInMinutes(invokeRunMaxDurationInMinutes)
.metastoreId(metastoreId)
.numExecutors(invokeRunNumExecutors)
.opcParentRptUrl(invokeRunOpcParentRptUrl)
.parameters(InvokeRunParameterArgs.builder()
.name(invokeRunParametersName)
.value(invokeRunParametersValue)
.build())
.poolId(testPool.id())
.sparkVersion(invokeRunSparkVersion)
.type(invokeRunType)
.warehouseBucketUri(invokeRunWarehouseBucketUri)
.build());
}
}
resources:
testInvokeRun:
type: oci:DataFlow:InvokeRun
name: test_invoke_run
properties:
compartmentId: ${compartmentId}
applicationId: ${testApplication.id}
applicationLogConfig:
logGroupId: ${testLogGroup.id}
logId: ${testLog.id}
archiveUri: ${invokeRunArchiveUri}
arguments: ${invokeRunArguments}
configuration: ${invokeRunConfiguration}
definedTags:
Operations.CostCenter: '42'
displayName: ${invokeRunDisplayName}
driverShape: ${invokeRunDriverShape}
driverShapeConfig:
memoryInGbs: ${invokeRunDriverShapeConfigMemoryInGbs}
ocpus: ${invokeRunDriverShapeConfigOcpus}
execute: ${invokeRunExecute}
executorShape: ${invokeRunExecutorShape}
executorShapeConfig:
memoryInGbs: ${invokeRunExecutorShapeConfigMemoryInGbs}
ocpus: ${invokeRunExecutorShapeConfigOcpus}
freeformTags:
Department: Finance
idleTimeoutInMinutes: ${invokeRunIdleTimeoutInMinutes}
logsBucketUri: ${invokeRunLogsBucketUri}
maxDurationInMinutes: ${invokeRunMaxDurationInMinutes}
metastoreId: ${metastoreId}
numExecutors: ${invokeRunNumExecutors}
opcParentRptUrl: ${invokeRunOpcParentRptUrl}
parameters:
- name: ${invokeRunParametersName}
value: ${invokeRunParametersValue}
poolId: ${testPool.id}
sparkVersion: ${invokeRunSparkVersion}
type: ${invokeRunType}
warehouseBucketUri: ${invokeRunWarehouseBucketUri}
Note
At a time service allows only one run to succeed if user is trying to invoke runs on multiple applications which have Private Endpoints and service will proceed invoking only one run and put the rest of them in failed state.
Create InvokeRun Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new InvokeRun(name: string, args: InvokeRunArgs, opts?: CustomResourceOptions);@overload
def InvokeRun(resource_name: str,
args: InvokeRunArgs,
opts: Optional[ResourceOptions] = None)
@overload
def InvokeRun(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
executor_shape: Optional[str] = None,
application_log_config: Optional[_dataflow.InvokeRunApplicationLogConfigArgs] = None,
executor_shape_config: Optional[_dataflow.InvokeRunExecutorShapeConfigArgs] = None,
asynchronous: Optional[bool] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
configuration: Optional[Mapping[str, Any]] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
idle_timeout_in_minutes: Optional[str] = None,
driver_shape: Optional[str] = None,
driver_shape_config: Optional[_dataflow.InvokeRunDriverShapeConfigArgs] = None,
execute: Optional[str] = None,
application_id: Optional[str] = None,
arguments: Optional[Sequence[str]] = None,
archive_uri: Optional[str] = None,
display_name: Optional[str] = None,
logs_bucket_uri: Optional[str] = None,
max_duration_in_minutes: Optional[str] = None,
metastore_id: Optional[str] = None,
num_executors: Optional[int] = None,
opc_parent_rpt_url: Optional[str] = None,
parameters: Optional[Sequence[_dataflow.InvokeRunParameterArgs]] = None,
pool_id: Optional[str] = None,
spark_version: Optional[str] = None,
type: Optional[str] = None,
warehouse_bucket_uri: Optional[str] = None)func NewInvokeRun(ctx *Context, name string, args InvokeRunArgs, opts ...ResourceOption) (*InvokeRun, error)public InvokeRun(string name, InvokeRunArgs args, CustomResourceOptions? opts = null)
public InvokeRun(String name, InvokeRunArgs args)
public InvokeRun(String name, InvokeRunArgs args, CustomResourceOptions options)
type: oci:DataFlow:InvokeRun
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args InvokeRunArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InvokeRunArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InvokeRunArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InvokeRunArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InvokeRunArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var invokeRunResource = new Oci.DataFlow.InvokeRun("invokeRunResource", new()
{
CompartmentId = "string",
ExecutorShape = "string",
ApplicationLogConfig = new Oci.DataFlow.Inputs.InvokeRunApplicationLogConfigArgs
{
LogGroupId = "string",
LogId = "string",
},
ExecutorShapeConfig = new Oci.DataFlow.Inputs.InvokeRunExecutorShapeConfigArgs
{
MemoryInGbs = 0,
Ocpus = 0,
},
Asynchronous = false,
FreeformTags =
{
{ "string", "any" },
},
Configuration =
{
{ "string", "any" },
},
DefinedTags =
{
{ "string", "any" },
},
IdleTimeoutInMinutes = "string",
DriverShape = "string",
DriverShapeConfig = new Oci.DataFlow.Inputs.InvokeRunDriverShapeConfigArgs
{
MemoryInGbs = 0,
Ocpus = 0,
},
Execute = "string",
ApplicationId = "string",
Arguments = new[]
{
"string",
},
ArchiveUri = "string",
DisplayName = "string",
LogsBucketUri = "string",
MaxDurationInMinutes = "string",
MetastoreId = "string",
NumExecutors = 0,
OpcParentRptUrl = "string",
Parameters = new[]
{
new Oci.DataFlow.Inputs.InvokeRunParameterArgs
{
Name = "string",
Value = "string",
},
},
PoolId = "string",
SparkVersion = "string",
Type = "string",
WarehouseBucketUri = "string",
});
example, err := DataFlow.NewInvokeRun(ctx, "invokeRunResource", &DataFlow.InvokeRunArgs{
CompartmentId: pulumi.String("string"),
ExecutorShape: pulumi.String("string"),
ApplicationLogConfig: &dataflow.InvokeRunApplicationLogConfigArgs{
LogGroupId: pulumi.String("string"),
LogId: pulumi.String("string"),
},
ExecutorShapeConfig: &dataflow.InvokeRunExecutorShapeConfigArgs{
MemoryInGbs: pulumi.Float64(0),
Ocpus: pulumi.Float64(0),
},
Asynchronous: pulumi.Bool(false),
FreeformTags: pulumi.Map{
"string": pulumi.Any("any"),
},
Configuration: pulumi.Map{
"string": pulumi.Any("any"),
},
DefinedTags: pulumi.Map{
"string": pulumi.Any("any"),
},
IdleTimeoutInMinutes: pulumi.String("string"),
DriverShape: pulumi.String("string"),
DriverShapeConfig: &dataflow.InvokeRunDriverShapeConfigArgs{
MemoryInGbs: pulumi.Float64(0),
Ocpus: pulumi.Float64(0),
},
Execute: pulumi.String("string"),
ApplicationId: pulumi.String("string"),
Arguments: pulumi.StringArray{
pulumi.String("string"),
},
ArchiveUri: pulumi.String("string"),
DisplayName: pulumi.String("string"),
LogsBucketUri: pulumi.String("string"),
MaxDurationInMinutes: pulumi.String("string"),
MetastoreId: pulumi.String("string"),
NumExecutors: pulumi.Int(0),
OpcParentRptUrl: pulumi.String("string"),
Parameters: dataflow.InvokeRunParameterArray{
&dataflow.InvokeRunParameterArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
PoolId: pulumi.String("string"),
SparkVersion: pulumi.String("string"),
Type: pulumi.String("string"),
WarehouseBucketUri: pulumi.String("string"),
})
var invokeRunResource = new InvokeRun("invokeRunResource", InvokeRunArgs.builder()
.compartmentId("string")
.executorShape("string")
.applicationLogConfig(InvokeRunApplicationLogConfigArgs.builder()
.logGroupId("string")
.logId("string")
.build())
.executorShapeConfig(InvokeRunExecutorShapeConfigArgs.builder()
.memoryInGbs(0)
.ocpus(0)
.build())
.asynchronous(false)
.freeformTags(Map.of("string", "any"))
.configuration(Map.of("string", "any"))
.definedTags(Map.of("string", "any"))
.idleTimeoutInMinutes("string")
.driverShape("string")
.driverShapeConfig(InvokeRunDriverShapeConfigArgs.builder()
.memoryInGbs(0)
.ocpus(0)
.build())
.execute("string")
.applicationId("string")
.arguments("string")
.archiveUri("string")
.displayName("string")
.logsBucketUri("string")
.maxDurationInMinutes("string")
.metastoreId("string")
.numExecutors(0)
.opcParentRptUrl("string")
.parameters(InvokeRunParameterArgs.builder()
.name("string")
.value("string")
.build())
.poolId("string")
.sparkVersion("string")
.type("string")
.warehouseBucketUri("string")
.build());
invoke_run_resource = oci.data_flow.InvokeRun("invokeRunResource",
compartment_id="string",
executor_shape="string",
application_log_config=oci.data_flow.InvokeRunApplicationLogConfigArgs(
log_group_id="string",
log_id="string",
),
executor_shape_config=oci.data_flow.InvokeRunExecutorShapeConfigArgs(
memory_in_gbs=0,
ocpus=0,
),
asynchronous=False,
freeform_tags={
"string": "any",
},
configuration={
"string": "any",
},
defined_tags={
"string": "any",
},
idle_timeout_in_minutes="string",
driver_shape="string",
driver_shape_config=oci.data_flow.InvokeRunDriverShapeConfigArgs(
memory_in_gbs=0,
ocpus=0,
),
execute="string",
application_id="string",
arguments=["string"],
archive_uri="string",
display_name="string",
logs_bucket_uri="string",
max_duration_in_minutes="string",
metastore_id="string",
num_executors=0,
opc_parent_rpt_url="string",
parameters=[oci.data_flow.InvokeRunParameterArgs(
name="string",
value="string",
)],
pool_id="string",
spark_version="string",
type="string",
warehouse_bucket_uri="string")
const invokeRunResource = new oci.dataflow.InvokeRun("invokeRunResource", {
compartmentId: "string",
executorShape: "string",
applicationLogConfig: {
logGroupId: "string",
logId: "string",
},
executorShapeConfig: {
memoryInGbs: 0,
ocpus: 0,
},
asynchronous: false,
freeformTags: {
string: "any",
},
configuration: {
string: "any",
},
definedTags: {
string: "any",
},
idleTimeoutInMinutes: "string",
driverShape: "string",
driverShapeConfig: {
memoryInGbs: 0,
ocpus: 0,
},
execute: "string",
applicationId: "string",
arguments: ["string"],
archiveUri: "string",
displayName: "string",
logsBucketUri: "string",
maxDurationInMinutes: "string",
metastoreId: "string",
numExecutors: 0,
opcParentRptUrl: "string",
parameters: [{
name: "string",
value: "string",
}],
poolId: "string",
sparkVersion: "string",
type: "string",
warehouseBucketUri: "string",
});
type: oci:DataFlow:InvokeRun
properties:
applicationId: string
applicationLogConfig:
logGroupId: string
logId: string
archiveUri: string
arguments:
- string
asynchronous: false
compartmentId: string
configuration:
string: any
definedTags:
string: any
displayName: string
driverShape: string
driverShapeConfig:
memoryInGbs: 0
ocpus: 0
execute: string
executorShape: string
executorShapeConfig:
memoryInGbs: 0
ocpus: 0
freeformTags:
string: any
idleTimeoutInMinutes: string
logsBucketUri: string
maxDurationInMinutes: string
metastoreId: string
numExecutors: 0
opcParentRptUrl: string
parameters:
- name: string
value: string
poolId: string
sparkVersion: string
type: string
warehouseBucketUri: string
InvokeRun Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The InvokeRun resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of a compartment.
- Application
Id string - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- Application
Log InvokeConfig Run Application Log Config - Logging details of Application logs for Data Flow Run.
- Archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- 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.
- Dictionary<string, object>
- (Updatable) 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 string - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- Driver
Shape string - The VM shape for the driver. Sets the driver cores and memory.
- Driver
Shape InvokeConfig Run Driver Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 string - The VM shape for the executors. Sets the executor cores and memory.
- Executor
Shape InvokeConfig Run Executor Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- Dictionary<string, object>
- (Updatable) 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"} - Idle
Timeout stringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - Logs
Bucket stringUri - 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.
- Max
Duration stringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - Metastore
Id string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- Num
Executors int - The number of executor VMs requested.
- Opc
Parent stringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- Parameters
List<Invoke
Run Parameter> - 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}"} ] - Pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- Spark
Version string - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- Type string
- The Spark application processing type.
- Warehouse
Bucket stringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - (Updatable) The OCID of a compartment.
- Application
Id string - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- Application
Log InvokeConfig Run Application Log Config Args - Logging details of Application logs for Data Flow Run.
- Archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- 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.
- map[string]interface{}
- (Updatable) 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 string - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- Driver
Shape string - The VM shape for the driver. Sets the driver cores and memory.
- Driver
Shape InvokeConfig Run Driver Shape Config Args - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 string - The VM shape for the executors. Sets the executor cores and memory.
- Executor
Shape InvokeConfig Run Executor Shape Config Args - This is used to configure the shape of the driver or executor if a flexible shape is used.
- map[string]interface{}
- (Updatable) 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"} - Idle
Timeout stringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - Logs
Bucket stringUri - 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.
- Max
Duration stringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - Metastore
Id string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- Num
Executors int - The number of executor VMs requested.
- Opc
Parent stringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- Parameters
[]Invoke
Run Parameter Args - 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}"} ] - Pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- Spark
Version string - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- Type string
- The Spark application processing type.
- Warehouse
Bucket stringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of a compartment.
- application
Id String - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- application
Log InvokeConfig Run Application Log Config - Logging details of Application logs for Data Flow Run.
- archive
Uri String - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- 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.
- Map<String,Object>
- (Updatable) 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 String - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- driver
Shape String - The VM shape for the driver. Sets the driver cores and memory.
- driver
Shape InvokeConfig Run Driver Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 String - The VM shape for the executors. Sets the executor cores and memory.
- executor
Shape InvokeConfig Run Executor Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- Map<String,Object>
- (Updatable) 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"} - idle
Timeout StringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - logs
Bucket StringUri - 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.
- max
Duration StringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - metastore
Id String - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors Integer - The number of executor VMs requested.
- opc
Parent StringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- parameters
List<Invoke
Run Parameter> - 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}"} ] - pool
Id String - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- spark
Version String - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- type String
- The Spark application processing type.
- warehouse
Bucket StringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id string - (Updatable) The OCID of a compartment.
- application
Id string - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- application
Log InvokeConfig Run Application Log Config - Logging details of Application logs for Data Flow Run.
- archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- 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.
- {[key: string]: any}
- (Updatable) 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 string - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- driver
Shape string - The VM shape for the driver. Sets the driver cores and memory.
- driver
Shape InvokeConfig Run Driver Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 string - The VM shape for the executors. Sets the executor cores and memory.
- executor
Shape InvokeConfig Run Executor Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- {[key: string]: any}
- (Updatable) 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"} - idle
Timeout stringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - logs
Bucket stringUri - 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.
- max
Duration stringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - metastore
Id string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors number - The number of executor VMs requested.
- opc
Parent stringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- parameters
Invoke
Run Parameter[] - 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}"} ] - pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- spark
Version string - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- type string
- The Spark application processing type.
- warehouse
Bucket stringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment_
id str - (Updatable) The OCID of a compartment.
- application_
id str - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- application_
log_ dataflow.config Invoke Run Application Log Config Args - Logging details of Application logs for Data Flow Run.
- archive_
uri str - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- 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.
- Mapping[str, Any]
- (Updatable) 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 - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- driver_
shape str - The VM shape for the driver. Sets the driver cores and memory.
- driver_
shape_ dataflow.config Invoke Run Driver Shape Config Args - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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.
- executor_
shape_ dataflow.config Invoke Run Executor Shape Config Args - This is used to configure the shape of the driver or executor if a flexible shape is used.
- Mapping[str, Any]
- (Updatable) 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"} - idle_
timeout_ strin_ minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - logs_
bucket_ struri - 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.
- max_
duration_ strin_ minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - metastore_
id str - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num_
executors int - The number of executor VMs requested.
- opc_
parent_ strrpt_ url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- parameters
Sequence[dataflow.
Invoke Run Parameter Args] - 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}"} ] - pool_
id str - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- spark_
version str - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- type str
- The Spark application processing type.
- warehouse_
bucket_ struri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of a compartment.
- application
Id String - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- application
Log Property MapConfig - Logging details of Application logs for Data Flow Run.
- archive
Uri String - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- 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.
- Map<Any>
- (Updatable) 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 String - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- driver
Shape String - The VM shape for the driver. Sets the driver cores and memory.
- driver
Shape Property MapConfig - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 String - The VM shape for the executors. Sets the executor cores and memory.
- executor
Shape Property MapConfig - This is used to configure the shape of the driver or executor if a flexible shape is used.
- Map<Any>
- (Updatable) 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"} - idle
Timeout StringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - logs
Bucket StringUri - 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.
- max
Duration StringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - metastore
Id String - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors Number - The number of executor VMs requested.
- opc
Parent StringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- 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}"} ] - pool
Id String - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- spark
Version String - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- type String
- The Spark application processing type.
- warehouse
Bucket StringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the InvokeRun resource produces the following output properties:
- Class
Name string - The class for the application.
- Data
Read stringIn Bytes - The data read by the run in bytes.
- Data
Written stringIn Bytes - The data written by the run in bytes.
- File
Uri 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Language string
- The Spark language.
- Lifecycle
Details string - The detailed messages about the lifecycle state.
- Opc
Request stringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- Owner
Principal stringId - The OCID of the user who created the resource.
- Owner
User stringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - Private
Endpoint List<string>Dns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - Private
Endpoint stringId - The OCID of a private endpoint.
- Private
Endpoint intMax Host Count - 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 List<string>Nsg Ids - An array of network security group OCIDs.
- Private
Endpoint stringSubnet Id - The OCID of a subnet.
- Run
Duration stringIn Milliseconds - The duration of the run in milliseconds.
- State string
- The current state of this run.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - Time
Updated string - The date and time the resource 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.
- Class
Name string - The class for the application.
- Data
Read stringIn Bytes - The data read by the run in bytes.
- Data
Written stringIn Bytes - The data written by the run in bytes.
- File
Uri 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Language string
- The Spark language.
- Lifecycle
Details string - The detailed messages about the lifecycle state.
- Opc
Request stringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- Owner
Principal stringId - The OCID of the user who created the resource.
- Owner
User stringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - Private
Endpoint []stringDns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - Private
Endpoint stringId - The OCID of a private endpoint.
- Private
Endpoint intMax Host Count - 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 []stringNsg Ids - An array of network security group OCIDs.
- Private
Endpoint stringSubnet Id - The OCID of a subnet.
- Run
Duration stringIn Milliseconds - The duration of the run in milliseconds.
- State string
- The current state of this run.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - Time
Updated string - The date and time the resource 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.
- class
Name String - The class for the application.
- data
Read StringIn Bytes - The data read by the run in bytes.
- data
Written StringIn Bytes - The data written by the run in bytes.
- file
Uri 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.
- id String
- The provider-assigned unique ID for this managed resource.
- language String
- The Spark language.
- lifecycle
Details String - The detailed messages about the lifecycle state.
- opc
Request StringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- owner
Principal StringId - The OCID of the user who created the resource.
- owner
User StringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - private
Endpoint List<String>Dns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - private
Endpoint StringId - The OCID of a private endpoint.
- private
Endpoint IntegerMax Host Count - 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 List<String>Nsg Ids - An array of network security group OCIDs.
- private
Endpoint StringSubnet Id - The OCID of a subnet.
- run
Duration StringIn Milliseconds - The duration of the run in milliseconds.
- state String
- The current state of this run.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - time
Updated String - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - total
Ocpu Integer - The total number of oCPU requested by the run.
- class
Name string - The class for the application.
- data
Read stringIn Bytes - The data read by the run in bytes.
- data
Written stringIn Bytes - The data written by the run in bytes.
- file
Uri 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.
- id string
- The provider-assigned unique ID for this managed resource.
- language string
- The Spark language.
- lifecycle
Details string - The detailed messages about the lifecycle state.
- opc
Request stringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- owner
Principal stringId - The OCID of the user who created the resource.
- owner
User stringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - private
Endpoint string[]Dns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - private
Endpoint stringId - The OCID of a private endpoint.
- private
Endpoint numberMax Host Count - 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 string[]Nsg Ids - An array of network security group OCIDs.
- private
Endpoint stringSubnet Id - The OCID of a subnet.
- run
Duration stringIn Milliseconds - The duration of the run in milliseconds.
- state string
- The current state of this run.
- time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - time
Updated string - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - total
Ocpu number - The total number of oCPU requested by the run.
- class_
name str - The class for the application.
- data_
read_ strin_ bytes - The data read by the run in bytes.
- data_
written_ strin_ bytes - The data written by the run in bytes.
- 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.
- id str
- The provider-assigned unique ID for this managed resource.
- language str
- The Spark language.
- lifecycle_
details str - The detailed messages about the lifecycle state.
- opc_
request_ strid - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- owner_
principal_ strid - The OCID of the user who created the resource.
- owner_
user_ strname - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - private_
endpoint_ Sequence[str]dns_ zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - private_
endpoint_ strid - The OCID of a private endpoint.
- private_
endpoint_ intmax_ host_ count - 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_ Sequence[str]nsg_ ids - An array of network security group OCIDs.
- private_
endpoint_ strsubnet_ id - The OCID of a subnet.
- run_
duration_ strin_ milliseconds - The duration of the run in milliseconds.
- state str
- The current state of this run.
- time_
created str - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - time_
updated str - The date and time the resource 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.
- class
Name String - The class for the application.
- data
Read StringIn Bytes - The data read by the run in bytes.
- data
Written StringIn Bytes - The data written by the run in bytes.
- file
Uri 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.
- id String
- The provider-assigned unique ID for this managed resource.
- language String
- The Spark language.
- lifecycle
Details String - The detailed messages about the lifecycle state.
- opc
Request StringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- owner
Principal StringId - The OCID of the user who created the resource.
- owner
User StringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - private
Endpoint List<String>Dns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - private
Endpoint StringId - The OCID of a private endpoint.
- private
Endpoint NumberMax Host Count - 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 List<String>Nsg Ids - An array of network security group OCIDs.
- private
Endpoint StringSubnet Id - The OCID of a subnet.
- run
Duration StringIn Milliseconds - The duration of the run in milliseconds.
- state String
- The current state of this run.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - time
Updated String - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - total
Ocpu Number - The total number of oCPU requested by the run.
Look up Existing InvokeRun Resource
Get an existing InvokeRun resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: InvokeRunState, opts?: CustomResourceOptions): InvokeRun@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
application_id: Optional[str] = None,
application_log_config: Optional[_dataflow.InvokeRunApplicationLogConfigArgs] = None,
archive_uri: Optional[str] = None,
arguments: Optional[Sequence[str]] = None,
asynchronous: Optional[bool] = None,
class_name: Optional[str] = None,
compartment_id: Optional[str] = None,
configuration: Optional[Mapping[str, Any]] = None,
data_read_in_bytes: Optional[str] = None,
data_written_in_bytes: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
display_name: Optional[str] = None,
driver_shape: Optional[str] = None,
driver_shape_config: Optional[_dataflow.InvokeRunDriverShapeConfigArgs] = None,
execute: Optional[str] = None,
executor_shape: Optional[str] = None,
executor_shape_config: Optional[_dataflow.InvokeRunExecutorShapeConfigArgs] = None,
file_uri: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
idle_timeout_in_minutes: Optional[str] = None,
language: Optional[str] = None,
lifecycle_details: Optional[str] = None,
logs_bucket_uri: Optional[str] = None,
max_duration_in_minutes: Optional[str] = None,
metastore_id: Optional[str] = None,
num_executors: Optional[int] = None,
opc_parent_rpt_url: Optional[str] = None,
opc_request_id: Optional[str] = None,
owner_principal_id: Optional[str] = None,
owner_user_name: Optional[str] = None,
parameters: Optional[Sequence[_dataflow.InvokeRunParameterArgs]] = None,
pool_id: Optional[str] = None,
private_endpoint_dns_zones: Optional[Sequence[str]] = None,
private_endpoint_id: Optional[str] = None,
private_endpoint_max_host_count: Optional[int] = None,
private_endpoint_nsg_ids: Optional[Sequence[str]] = None,
private_endpoint_subnet_id: Optional[str] = None,
run_duration_in_milliseconds: Optional[str] = None,
spark_version: Optional[str] = None,
state: Optional[str] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
total_ocpu: Optional[int] = None,
type: Optional[str] = None,
warehouse_bucket_uri: Optional[str] = None) -> InvokeRunfunc GetInvokeRun(ctx *Context, name string, id IDInput, state *InvokeRunState, opts ...ResourceOption) (*InvokeRun, error)public static InvokeRun Get(string name, Input<string> id, InvokeRunState? state, CustomResourceOptions? opts = null)public static InvokeRun get(String name, Output<String> id, InvokeRunState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Application
Id string - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- Application
Log InvokeConfig Run Application Log Config - Logging details of Application logs for Data Flow Run.
- Archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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 string - The class for the application.
- Compartment
Id string - (Updatable) The OCID of a 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.
- Data
Read stringIn Bytes - The data read by the run in bytes.
- Data
Written stringIn Bytes - The data written by the run in bytes.
- Dictionary<string, object>
- (Updatable) 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 string - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- Driver
Shape string - The VM shape for the driver. Sets the driver cores and memory.
- Driver
Shape InvokeConfig Run Driver Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 string - The VM shape for the executors. Sets the executor cores and memory.
- Executor
Shape InvokeConfig Run Executor Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- File
Uri 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.
- Dictionary<string, object>
- (Updatable) 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"} - Idle
Timeout stringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - Language string
- The Spark language.
- Lifecycle
Details string - The detailed messages about the lifecycle state.
- Logs
Bucket stringUri - 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.
- Max
Duration stringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - Metastore
Id string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- Num
Executors int - The number of executor VMs requested.
- Opc
Parent stringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- Opc
Request stringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- Owner
Principal stringId - The OCID of the user who created the resource.
- Owner
User stringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - Parameters
List<Invoke
Run Parameter> - 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}"} ] - Pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- Private
Endpoint List<string>Dns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - Private
Endpoint stringId - The OCID of a private endpoint.
- Private
Endpoint intMax Host Count - 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 List<string>Nsg Ids - An array of network security group OCIDs.
- Private
Endpoint stringSubnet Id - The OCID of a subnet.
- Run
Duration stringIn Milliseconds - The duration of the run in milliseconds.
- Spark
Version string - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- State string
- The current state of this run.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - Time
Updated string - The date and time the resource 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 string
- The Spark application processing type.
- Warehouse
Bucket stringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Application
Id string - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- Application
Log InvokeConfig Run Application Log Config Args - Logging details of Application logs for Data Flow Run.
- Archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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 string - The class for the application.
- Compartment
Id string - (Updatable) The OCID of a 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.
- Data
Read stringIn Bytes - The data read by the run in bytes.
- Data
Written stringIn Bytes - The data written by the run in bytes.
- map[string]interface{}
- (Updatable) 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 string - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- Driver
Shape string - The VM shape for the driver. Sets the driver cores and memory.
- Driver
Shape InvokeConfig Run Driver Shape Config Args - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 string - The VM shape for the executors. Sets the executor cores and memory.
- Executor
Shape InvokeConfig Run Executor Shape Config Args - This is used to configure the shape of the driver or executor if a flexible shape is used.
- File
Uri 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.
- map[string]interface{}
- (Updatable) 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"} - Idle
Timeout stringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - Language string
- The Spark language.
- Lifecycle
Details string - The detailed messages about the lifecycle state.
- Logs
Bucket stringUri - 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.
- Max
Duration stringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - Metastore
Id string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- Num
Executors int - The number of executor VMs requested.
- Opc
Parent stringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- Opc
Request stringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- Owner
Principal stringId - The OCID of the user who created the resource.
- Owner
User stringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - Parameters
[]Invoke
Run Parameter Args - 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}"} ] - Pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- Private
Endpoint []stringDns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - Private
Endpoint stringId - The OCID of a private endpoint.
- Private
Endpoint intMax Host Count - 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 []stringNsg Ids - An array of network security group OCIDs.
- Private
Endpoint stringSubnet Id - The OCID of a subnet.
- Run
Duration stringIn Milliseconds - The duration of the run in milliseconds.
- Spark
Version string - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- State string
- The current state of this run.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - Time
Updated string - The date and time the resource 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 string
- The Spark application processing type.
- Warehouse
Bucket stringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- application
Id String - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- application
Log InvokeConfig Run Application Log Config - Logging details of Application logs for Data Flow Run.
- archive
Uri String - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- class
Name String - The class for the application.
- compartment
Id String - (Updatable) The OCID of a 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.
- data
Read StringIn Bytes - The data read by the run in bytes.
- data
Written StringIn Bytes - The data written by the run in bytes.
- Map<String,Object>
- (Updatable) 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 String - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- driver
Shape String - The VM shape for the driver. Sets the driver cores and memory.
- driver
Shape InvokeConfig Run Driver Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 String - The VM shape for the executors. Sets the executor cores and memory.
- executor
Shape InvokeConfig Run Executor Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- file
Uri 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.
- Map<String,Object>
- (Updatable) 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"} - idle
Timeout StringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - language String
- The Spark language.
- lifecycle
Details String - The detailed messages about the lifecycle state.
- logs
Bucket StringUri - 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.
- max
Duration StringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - metastore
Id String - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors Integer - The number of executor VMs requested.
- opc
Parent StringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- opc
Request StringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- owner
Principal StringId - The OCID of the user who created the resource.
- owner
User StringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - parameters
List<Invoke
Run Parameter> - 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}"} ] - pool
Id String - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- private
Endpoint List<String>Dns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - private
Endpoint StringId - The OCID of a private endpoint.
- private
Endpoint IntegerMax Host Count - 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 List<String>Nsg Ids - An array of network security group OCIDs.
- private
Endpoint StringSubnet Id - The OCID of a subnet.
- run
Duration StringIn Milliseconds - The duration of the run in milliseconds.
- spark
Version String - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- state String
- The current state of this run.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - time
Updated String - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - total
Ocpu Integer - The total number of oCPU requested by the run.
- type String
- The Spark application processing type.
- warehouse
Bucket StringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- application
Id string - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- application
Log InvokeConfig Run Application Log Config - Logging details of Application logs for Data Flow Run.
- archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- class
Name string - The class for the application.
- compartment
Id string - (Updatable) The OCID of a 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.
- data
Read stringIn Bytes - The data read by the run in bytes.
- data
Written stringIn Bytes - The data written by the run in bytes.
- {[key: string]: any}
- (Updatable) 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 string - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- driver
Shape string - The VM shape for the driver. Sets the driver cores and memory.
- driver
Shape InvokeConfig Run Driver Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 string - The VM shape for the executors. Sets the executor cores and memory.
- executor
Shape InvokeConfig Run Executor Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- file
Uri 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.
- {[key: string]: any}
- (Updatable) 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"} - idle
Timeout stringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - language string
- The Spark language.
- lifecycle
Details string - The detailed messages about the lifecycle state.
- logs
Bucket stringUri - 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.
- max
Duration stringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - metastore
Id string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors number - The number of executor VMs requested.
- opc
Parent stringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- opc
Request stringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- owner
Principal stringId - The OCID of the user who created the resource.
- owner
User stringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - parameters
Invoke
Run Parameter[] - 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}"} ] - pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- private
Endpoint string[]Dns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - private
Endpoint stringId - The OCID of a private endpoint.
- private
Endpoint numberMax Host Count - 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 string[]Nsg Ids - An array of network security group OCIDs.
- private
Endpoint stringSubnet Id - The OCID of a subnet.
- run
Duration stringIn Milliseconds - The duration of the run in milliseconds.
- spark
Version string - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- state string
- The current state of this run.
- time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - time
Updated string - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - total
Ocpu number - The total number of oCPU requested by the run.
- type string
- The Spark application processing type.
- warehouse
Bucket stringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- application_
id str - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- application_
log_ dataflow.config Invoke Run Application Log Config Args - Logging details of Application logs for Data Flow Run.
- archive_
uri str - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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 - (Updatable) The OCID of a 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_ strin_ bytes - The data read by the run in bytes.
- data_
written_ strin_ bytes - The data written by the run in bytes.
- Mapping[str, Any]
- (Updatable) 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 - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- driver_
shape str - The VM shape for the driver. Sets the driver cores and memory.
- driver_
shape_ dataflow.config Invoke Run Driver Shape Config Args - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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.
- executor_
shape_ dataflow.config Invoke Run Executor Shape Config Args - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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.
- Mapping[str, Any]
- (Updatable) 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"} - idle_
timeout_ strin_ minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - language str
- The Spark language.
- lifecycle_
details str - The detailed messages about the lifecycle state.
- logs_
bucket_ struri - 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.
- max_
duration_ strin_ minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - metastore_
id str - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num_
executors int - The number of executor VMs requested.
- opc_
parent_ strrpt_ url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- opc_
request_ strid - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- owner_
principal_ strid - The OCID of the user who created the resource.
- owner_
user_ strname - The username of the user who created the resource. If the username of the owner does not exist,
nullwill be returned and the caller should refer to the ownerPrincipalId value instead. - parameters
Sequence[dataflow.
Invoke Run Parameter Args] - 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}"} ] - pool_
id str - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- private_
endpoint_ Sequence[str]dns_ zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - private_
endpoint_ strid - The OCID of a private endpoint.
- private_
endpoint_ intmax_ host_ count - 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_ Sequence[str]nsg_ ids - An array of network security group OCIDs.
- private_
endpoint_ strsubnet_ id - The OCID of a subnet.
- run_
duration_ strin_ milliseconds - The duration of the run in milliseconds.
- spark_
version str - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- state str
- The current state of this run.
- time_
created str - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - time_
updated str - The date and time the resource 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_ struri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- application
Id String - The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
- application
Log Property MapConfig - Logging details of Application logs for Data Flow Run.
- archive
Uri String - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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, wherenameis 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
- class
Name String - The class for the application.
- compartment
Id String - (Updatable) The OCID of a 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.
- data
Read StringIn Bytes - The data read by the run in bytes.
- data
Written StringIn Bytes - The data written by the run in bytes.
- Map<Any>
- (Updatable) 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 String - A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
- driver
Shape String - The VM shape for the driver. Sets the driver cores and memory.
- driver
Shape Property MapConfig - This is used to configure the shape of the driver or executor if a flexible shape is used.
- 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 10Note: 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 String - The VM shape for the executors. Sets the executor cores and memory.
- executor
Shape Property MapConfig - This is used to configure the shape of the driver or executor if a flexible shape is used.
- file
Uri 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.
- Map<Any>
- (Updatable) 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"} - idle
Timeout StringIn Minutes - (Updatable) The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type
SESSION. Default value is 2880 minutes (2 days) - language String
- The Spark language.
- lifecycle
Details String - The detailed messages about the lifecycle state.
- logs
Bucket StringUri - 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.
- max
Duration StringIn Minutes - (Updatable) The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to
IN_PROGRESSstate. - metastore
Id String - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors Number - The number of executor VMs requested.
- opc
Parent StringRpt Url - (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
- opc
Request StringId - Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
- owner
Principal StringId - The OCID of the user who created the resource.
- owner
User StringName - The username of the user who created the resource. If the username of the owner does not exist,
nullwill 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}"} ] - pool
Id String - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- private
Endpoint List<String>Dns Zones - An array of DNS zone names. Example:
[ "app.examplecorp.com", "app.examplecorp2.com" ] - private
Endpoint StringId - The OCID of a private endpoint.
- private
Endpoint NumberMax Host Count - 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 List<String>Nsg Ids - An array of network security group OCIDs.
- private
Endpoint StringSubnet Id - The OCID of a subnet.
- run
Duration StringIn Milliseconds - The duration of the run in milliseconds.
- spark
Version String - The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
- state String
- The current state of this run.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - time
Updated String - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z - total
Ocpu Number - The total number of oCPU requested by the run.
- type String
- The Spark application processing type.
- warehouse
Bucket StringUri 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Supporting Types
InvokeRunApplicationLogConfig, InvokeRunApplicationLogConfigArgs
- Log
Group stringId - The log group id for where log objects will be for Data Flow Runs.
- Log
Id string - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- Log
Group stringId - The log group id for where log objects will be for Data Flow Runs.
- Log
Id string - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- log
Group StringId - The log group id for where log objects will be for Data Flow Runs.
- log
Id String - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- log
Group stringId - The log group id for where log objects will be for Data Flow Runs.
- log
Id string - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- log_
group_ strid - The log group id for where log objects will be for Data Flow Runs.
- log_
id str - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- log
Group StringId - The log group id for where log objects will be for Data Flow Runs.
- log
Id String - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
InvokeRunDriverShapeConfig, InvokeRunDriverShapeConfigArgs
- Memory
In doubleGbs - The amount of memory used for the driver or executors.
- Ocpus double
- The total number of OCPUs used for the driver or executors. See here for details.
- Memory
In float64Gbs - The amount of memory used for the driver or executors.
- Ocpus float64
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In DoubleGbs - The amount of memory used for the driver or executors.
- ocpus Double
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In numberGbs - The amount of memory used for the driver or executors.
- ocpus number
- The total number of OCPUs used for the driver or executors. See here for details.
- memory_
in_ floatgbs - The amount of memory used for the driver or executors.
- ocpus float
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In NumberGbs - The amount of memory used for the driver or executors.
- ocpus Number
- The total number of OCPUs used for the driver or executors. See here for details.
InvokeRunExecutorShapeConfig, InvokeRunExecutorShapeConfigArgs
- Memory
In doubleGbs - The amount of memory used for the driver or executors.
- Ocpus double
- The total number of OCPUs used for the driver or executors. See here for details.
- Memory
In float64Gbs - The amount of memory used for the driver or executors.
- Ocpus float64
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In DoubleGbs - The amount of memory used for the driver or executors.
- ocpus Double
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In numberGbs - The amount of memory used for the driver or executors.
- ocpus number
- The total number of OCPUs used for the driver or executors. See here for details.
- memory_
in_ floatgbs - The amount of memory used for the driver or executors.
- ocpus float
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In NumberGbs - The amount of memory used for the driver or executors.
- ocpus Number
- The total number of OCPUs used for the driver or executors. See here for details.
InvokeRunParameter, InvokeRunParameterArgs
Import
InvokeRuns can be imported using the id, e.g.
$ pulumi import oci:DataFlow/invokeRun:InvokeRun test_invoke_run "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi