Oracle Cloud Infrastructure v1.35.0, May 10 24

Oracle Cloud Infrastructure v1.35.0 published on Friday, May 10, 2024 by Pulumi

oci.DataFlow.getInvokeRun

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.35.0 published on Friday, May 10, 2024 by Pulumi

Example Usage

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

const testInvokeRun = oci.DataFlow.getInvokeRun({
    runId: testRun.id,
});

import pulumi
import pulumi_oci as oci

test_invoke_run = oci.DataFlow.get_invoke_run(run_id=test_run["id"])

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.GetInvokeRun(ctx, &dataflow.GetInvokeRunArgs{
			RunId: testRun.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testInvokeRun = Oci.DataFlow.GetInvokeRun.Invoke(new()
    {
        RunId = testRun.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataFlow.DataFlowFunctions;
import com.pulumi.oci.DataFlow.inputs.GetInvokeRunArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testInvokeRun = DataFlowFunctions.getInvokeRun(GetInvokeRunArgs.builder()
            .runId(testRun.id())
            .build());

    }
}

variables:
  testInvokeRun:
    fn::invoke:
      Function: oci:DataFlow:getInvokeRun
      Arguments:
        runId: ${testRun.id}

Using getInvokeRun

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInvokeRun(args: GetInvokeRunArgs, opts?: InvokeOptions): Promise<GetInvokeRunResult>
function getInvokeRunOutput(args: GetInvokeRunOutputArgs, opts?: InvokeOptions): Output<GetInvokeRunResult>

def get_invoke_run(run_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetInvokeRunResult
def get_invoke_run_output(run_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetInvokeRunResult]

func GetInvokeRun(ctx *Context, args *GetInvokeRunArgs, opts ...InvokeOption) (*GetInvokeRunResult, error)
func GetInvokeRunOutput(ctx *Context, args *GetInvokeRunOutputArgs, opts ...InvokeOption) GetInvokeRunResultOutput

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

public static class GetInvokeRun 
{
    public static Task<GetInvokeRunResult> InvokeAsync(GetInvokeRunArgs args, InvokeOptions? opts = null)
    public static Output<GetInvokeRunResult> Invoke(GetInvokeRunInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInvokeRunResult> getInvokeRun(GetInvokeRunArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DataFlow/getInvokeRun:getInvokeRun
  arguments:
    # arguments dictionary

The following arguments are supported:

RunId string: The unique ID for the run

RunId string: The unique ID for the run

runId String: The unique ID for the run

runId string: The unique ID for the run

run_id str: The unique ID for the run

runId String: The unique ID for the run

getInvokeRun Result

The following output properties are available:

ApplicationId string: The application ID.
ApplicationLogConfigs List<GetInvokeRunApplicationLogConfig>: Logging details of Application logs for Data Flow Run.
ArchiveUri 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, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"
Asynchronous bool
ClassName string: The class for the application.
CompartmentId string: The OCID of 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.
DataReadInBytes string: The data read by the run in bytes.
DataWrittenInBytes string: The data written by the run in bytes.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name. This name is not necessarily unique.
DriverShape string: The VM shape for the driver. Sets the driver cores and memory.
DriverShapeConfigs List<GetInvokeRunDriverShapeConfig>: 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 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.
ExecutorShape string: The VM shape for the executors. Sets the executor cores and memory.
ExecutorShapeConfigs List<GetInvokeRunExecutorShapeConfig>: This is used to configure the shape of the driver or executor if a flexible shape is used.
FileUri string: An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
FreeformTags Dictionary<string, object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The ID of a run.
IdleTimeoutInMinutes string: 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.
LifecycleDetails string: The detailed messages about the lifecycle state.
LogsBucketUri string: An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
MaxDurationInMinutes string: 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_PROGRESS state.
MetastoreId string: The OCID of Oracle Cloud Infrastructure Hive Metastore.
NumExecutors int: The number of executor VMs requested.
OpcParentRptUrl string
OpcRequestId string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OwnerPrincipalId string: The OCID of the user who created the resource.
OwnerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
Parameters List<GetInvokeRunParameter>: 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}"} ]
PoolId string: The OCID of a pool. Unique Id to indentify a dataflow pool resource.
PrivateEndpointDnsZones List<string>: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
PrivateEndpointId string: The OCID of a private endpoint.
PrivateEndpointMaxHostCount int: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
PrivateEndpointNsgIds List<string>: An array of network security group OCIDs.
PrivateEndpointSubnetId string: The OCID of a subnet.
RunDurationInMilliseconds string: The duration of the run in milliseconds.
RunId string
SparkVersion string: The Spark version utilized to run the application.
State string: The current state of this run.
TimeCreated string: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeUpdated string: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TotalOcpu int: The total number of oCPU requested by the run.
Type string: The Spark application processing type.
WarehouseBucketUri string: An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

ApplicationId string: The application ID.
ApplicationLogConfigs []GetInvokeRunApplicationLogConfig: Logging details of Application logs for Data Flow Run.
ArchiveUri 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, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"
Asynchronous bool
ClassName string: The class for the application.
CompartmentId string: The OCID of 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.
DataReadInBytes string: The data read by the run in bytes.
DataWrittenInBytes string: The data written by the run in bytes.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name. This name is not necessarily unique.
DriverShape string: The VM shape for the driver. Sets the driver cores and memory.
DriverShapeConfigs []GetInvokeRunDriverShapeConfig: 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 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.
ExecutorShape string: The VM shape for the executors. Sets the executor cores and memory.
ExecutorShapeConfigs []GetInvokeRunExecutorShapeConfig: This is used to configure the shape of the driver or executor if a flexible shape is used.
FileUri string: An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
FreeformTags map[string]interface{}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The ID of a run.
IdleTimeoutInMinutes string: 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.
LifecycleDetails string: The detailed messages about the lifecycle state.
LogsBucketUri string: An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
MaxDurationInMinutes string: 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_PROGRESS state.
MetastoreId string: The OCID of Oracle Cloud Infrastructure Hive Metastore.
NumExecutors int: The number of executor VMs requested.
OpcParentRptUrl string
OpcRequestId string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OwnerPrincipalId string: The OCID of the user who created the resource.
OwnerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
Parameters []GetInvokeRunParameter: 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}"} ]
PoolId string: The OCID of a pool. Unique Id to indentify a dataflow pool resource.
PrivateEndpointDnsZones []string: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
PrivateEndpointId string: The OCID of a private endpoint.
PrivateEndpointMaxHostCount int: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
PrivateEndpointNsgIds []string: An array of network security group OCIDs.
PrivateEndpointSubnetId string: The OCID of a subnet.
RunDurationInMilliseconds string: The duration of the run in milliseconds.
RunId string
SparkVersion string: The Spark version utilized to run the application.
State string: The current state of this run.
TimeCreated string: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeUpdated string: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TotalOcpu int: The total number of oCPU requested by the run.
Type string: The Spark application processing type.
WarehouseBucketUri string: An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

applicationId String: The application ID.
applicationLogConfigs List<GetInvokeRunApplicationLogConfig>: Logging details of Application logs for Data Flow Run.
archiveUri 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, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"
asynchronous Boolean
className String: The class for the application.
compartmentId String: The OCID of 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.
dataReadInBytes String: The data read by the run in bytes.
dataWrittenInBytes String: The data written by the run in bytes.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name. This name is not necessarily unique.
driverShape String: The VM shape for the driver. Sets the driver cores and memory.
driverShapeConfigs List<GetInvokeRunDriverShapeConfig>: 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 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.
executorShape String: The VM shape for the executors. Sets the executor cores and memory.
executorShapeConfigs List<GetInvokeRunExecutorShapeConfig>: This is used to configure the shape of the driver or executor if a flexible shape is used.
fileUri String: An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
freeformTags Map<String,Object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The ID of a run.
idleTimeoutInMinutes String: 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.
lifecycleDetails String: The detailed messages about the lifecycle state.
logsBucketUri String: An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
maxDurationInMinutes String: 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_PROGRESS state.
metastoreId String: The OCID of Oracle Cloud Infrastructure Hive Metastore.
numExecutors Integer: The number of executor VMs requested.
opcParentRptUrl String
opcRequestId String: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
ownerPrincipalId String: The OCID of the user who created the resource.
ownerUserName String: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
parameters List<GetInvokeRunParameter>: 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}"} ]
poolId String: The OCID of a pool. Unique Id to indentify a dataflow pool resource.
privateEndpointDnsZones List<String>: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
privateEndpointId String: The OCID of a private endpoint.
privateEndpointMaxHostCount Integer: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
privateEndpointNsgIds List<String>: An array of network security group OCIDs.
privateEndpointSubnetId String: The OCID of a subnet.
runDurationInMilliseconds String: The duration of the run in milliseconds.
runId String
sparkVersion String: The Spark version utilized to run the application.
state String: The current state of this run.
timeCreated String: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated String: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
totalOcpu Integer: The total number of oCPU requested by the run.
type String: The Spark application processing type.
warehouseBucketUri String: An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

applicationId string: The application ID.
applicationLogConfigs GetInvokeRunApplicationLogConfig[]: Logging details of Application logs for Data Flow Run.
archiveUri 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, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"
asynchronous boolean
className string: The class for the application.
compartmentId string: The OCID of 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.
dataReadInBytes string: The data read by the run in bytes.
dataWrittenInBytes string: The data written by the run in bytes.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string: A user-friendly name. This name is not necessarily unique.
driverShape string: The VM shape for the driver. Sets the driver cores and memory.
driverShapeConfigs GetInvokeRunDriverShapeConfig[]: 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 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.
executorShape string: The VM shape for the executors. Sets the executor cores and memory.
executorShapeConfigs GetInvokeRunExecutorShapeConfig[]: This is used to configure the shape of the driver or executor if a flexible shape is used.
fileUri string: An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
freeformTags {[key: string]: any}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The ID of a run.
idleTimeoutInMinutes string: 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.
lifecycleDetails string: The detailed messages about the lifecycle state.
logsBucketUri string: An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
maxDurationInMinutes string: 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_PROGRESS state.
metastoreId string: The OCID of Oracle Cloud Infrastructure Hive Metastore.
numExecutors number: The number of executor VMs requested.
opcParentRptUrl string
opcRequestId string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
ownerPrincipalId string: The OCID of the user who created the resource.
ownerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
parameters GetInvokeRunParameter[]: 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}"} ]
poolId string: The OCID of a pool. Unique Id to indentify a dataflow pool resource.
privateEndpointDnsZones string[]: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
privateEndpointId string: The OCID of a private endpoint.
privateEndpointMaxHostCount number: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
privateEndpointNsgIds string[]: An array of network security group OCIDs.
privateEndpointSubnetId string: The OCID of a subnet.
runDurationInMilliseconds string: The duration of the run in milliseconds.
runId string
sparkVersion string: The Spark version utilized to run the application.
state string: The current state of this run.
timeCreated string: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated string: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
totalOcpu number: The total number of oCPU requested by the run.
type string: The Spark application processing type.
warehouseBucketUri string: An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

application_id str: The application ID.
application_log_configs Sequence[dataflow.GetInvokeRunApplicationLogConfig]: 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, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"
asynchronous bool
class_name str: The class for the application.
compartment_id str: The OCID of 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_in_bytes str: The data read by the run in bytes.
data_written_in_bytes str: The data written by the run in bytes.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str: A user-friendly name. This name is not necessarily unique.
driver_shape str: The VM shape for the driver. Sets the driver cores and memory.
driver_shape_configs Sequence[dataflow.GetInvokeRunDriverShapeConfig]: 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 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.
executor_shape str: The VM shape for the executors. Sets the executor cores and memory.
executor_shape_configs Sequence[dataflow.GetInvokeRunExecutorShapeConfig]: 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.
freeform_tags Mapping[str, Any]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The ID of a run.
idle_timeout_in_minutes str: 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_uri str: An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
max_duration_in_minutes str: 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_PROGRESS state.
metastore_id str: The OCID of Oracle Cloud Infrastructure Hive Metastore.
num_executors int: The number of executor VMs requested.
opc_parent_rpt_url str
opc_request_id str: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
owner_principal_id str: The OCID of the user who created the resource.
owner_user_name str: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
parameters Sequence[dataflow.GetInvokeRunParameter]: 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_dns_zones Sequence[str]: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
private_endpoint_id str: The OCID of a private endpoint.
private_endpoint_max_host_count int: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
private_endpoint_nsg_ids Sequence[str]: An array of network security group OCIDs.
private_endpoint_subnet_id str: The OCID of a subnet.
run_duration_in_milliseconds str: The duration of the run in milliseconds.
run_id str
spark_version str: The Spark version utilized to run the 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_uri str: An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

applicationId String: The application ID.
applicationLogConfigs List<Property Map>: Logging details of Application logs for Data Flow Run.
archiveUri 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, where name is the name of the parameter. Example: [ "--input", "${input_file}", "--name", "John Doe" ] If "input_file" has a value of "mydata.xml", then the value above will be translated to --input mydata.xml --name "John Doe"
asynchronous Boolean
className String: The class for the application.
compartmentId String: The OCID of 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.
dataReadInBytes String: The data read by the run in bytes.
dataWrittenInBytes String: The data written by the run in bytes.
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name. This name is not necessarily unique.
driverShape String: The VM shape for the driver. Sets the driver cores and memory.
driverShapeConfigs List<Property Map>: 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 10 Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.
executorShape String: The VM shape for the executors. Sets the executor cores and memory.
executorShapeConfigs List<Property Map>: This is used to configure the shape of the driver or executor if a flexible shape is used.
fileUri String: An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
freeformTags Map<Any>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The ID of a run.
idleTimeoutInMinutes String: 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.
lifecycleDetails String: The detailed messages about the lifecycle state.
logsBucketUri String: An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
maxDurationInMinutes String: 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_PROGRESS state.
metastoreId String: The OCID of Oracle Cloud Infrastructure Hive Metastore.
numExecutors Number: The number of executor VMs requested.
opcParentRptUrl String
opcRequestId String: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
ownerPrincipalId String: The OCID of the user who created the resource.
ownerUserName String: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
parameters List<Property Map>: An array of name/value pairs used to fill placeholders found in properties like Application.arguments. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]
poolId String: The OCID of a pool. Unique Id to indentify a dataflow pool resource.
privateEndpointDnsZones List<String>: An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
privateEndpointId String: The OCID of a private endpoint.
privateEndpointMaxHostCount Number: The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
privateEndpointNsgIds List<String>: An array of network security group OCIDs.
privateEndpointSubnetId String: The OCID of a subnet.
runDurationInMilliseconds String: The duration of the run in milliseconds.
runId String
sparkVersion String: The Spark version utilized to run the application.
state String: The current state of this run.
timeCreated String: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated String: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
totalOcpu Number: The total number of oCPU requested by the run.
type String: The Spark application processing type.
warehouseBucketUri String: An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

Supporting Types

GetInvokeRunApplicationLogConfig

LogGroupId string: The log group id for where log objects will be for Data Flow Runs.
LogId string: The log id of the log object the Application Logs of Data Flow Run will be shipped to.

LogGroupId string: The log group id for where log objects will be for Data Flow Runs.
LogId string: The log id of the log object the Application Logs of Data Flow Run will be shipped to.

logGroupId String: The log group id for where log objects will be for Data Flow Runs.
logId String: The log id of the log object the Application Logs of Data Flow Run will be shipped to.

logGroupId string: The log group id for where log objects will be for Data Flow Runs.
logId string: The log id of the log object the Application Logs of Data Flow Run will be shipped to.

log_group_id str: 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.

logGroupId String: The log group id for where log objects will be for Data Flow Runs.
logId String: The log id of the log object the Application Logs of Data Flow Run will be shipped to.

GetInvokeRunDriverShapeConfig

MemoryInGbs double: 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.

MemoryInGbs float64: 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.

memoryInGbs Double: 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.

memoryInGbs number: 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_gbs float: 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.

memoryInGbs Number: 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.

GetInvokeRunExecutorShapeConfig

MemoryInGbs double: 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.

MemoryInGbs float64: 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.

memoryInGbs Double: 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.

memoryInGbs number: 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_gbs float: 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.

memoryInGbs Number: 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.

GetInvokeRunParameter

Name string: The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"
Value string: The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

Name string: The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"
Value string: The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

name String: The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"
value String: The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

name string: The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"
value string: The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

name str: The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"
value str: The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

name String: The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file"
value String: The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}"

Package Details

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

Oracle Cloud Infrastructure v1.35.0 published on Friday, May 10, 2024 by Pulumi

pulumi/pulumi-oci

oci.DataFlow.getInvokeRun

On this page

On this page

Example Usage

Using getInvokeRun

getInvokeRun Result

Supporting Types

GetInvokeRunApplicationLogConfig

GetInvokeRunDriverShapeConfig

GetInvokeRunExecutorShapeConfig

GetInvokeRunParameter

Package Details

On this page

On this page