Oracle Cloud Infrastructure
getInvokeRun
This data source provides details about a specific Invoke Run resource in Oracle Cloud Infrastructure Data Flow service.
Retrieves the run for the specified runId
.
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testInvokeRun = Output.Create(Oci.DataFlow.GetInvokeRun.InvokeAsync(new Oci.DataFlow.GetInvokeRunArgs
{
RunId = oci_dataflow_run.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: oci_dataflow_run.Test_run.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_invoke_run = oci.DataFlow.get_invoke_run(run_id=oci_dataflow_run["test_run"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testInvokeRun = oci.DataFlow.getInvokeRun({
runId: oci_dataflow_run.test_run.id,
});
Coming soon!
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:
- Run
Id string The unique ID for the run
- Run
Id string The unique ID for the run
- run
Id String The unique ID for the run
- run
Id string The unique ID for the run
- run_
id str The unique ID for the run
- run
Id String The unique ID for the run
getInvokeRun Result
The following output properties are available:
- Application
Id string The application ID.
- Archive
Uri string An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Arguments List<string>
The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, wherename
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 string The class for the application.
- Compartment
Id 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.
- 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>
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. This name is not necessarily unique.
- Driver
Shape string The VM shape for the driver. Sets the driver cores and memory.
- Execute string
The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10
Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.- Executor
Shape string The VM shape for the executors. Sets the executor cores and memory.
- 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>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
The ID of a run.
- Language string
The Spark language.
- 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.
- Metastore
Id string The OCID of Oracle Cloud Infrastructure Hive Metastore.
- Num
Executors int The number of executor VMs requested.
- 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,
null
will be returned and the caller should refer to the ownerPrincipalId value instead.- Parameters
List<Get
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}"} ]- 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.
- Run
Id string - Spark
Version string The Spark version utilized to run the application.
- State string
The current state of this run.
- Time
Created string The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Time
Updated string The date and time a application was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Total
Ocpu int The total number of oCPU requested by the run.
- Type 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.
- Application
Id string The application ID.
- Archive
Uri string An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Arguments []string
The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, wherename
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 string The class for the application.
- Compartment
Id 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.
- 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{}
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. This name is not necessarily unique.
- Driver
Shape string The VM shape for the driver. Sets the driver cores and memory.
- Execute string
The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10
Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.- Executor
Shape string The VM shape for the executors. Sets the executor cores and memory.
- 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{}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
The ID of a run.
- Language string
The Spark language.
- 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.
- Metastore
Id string The OCID of Oracle Cloud Infrastructure Hive Metastore.
- Num
Executors int The number of executor VMs requested.
- 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,
null
will be returned and the caller should refer to the ownerPrincipalId value instead.- Parameters
[]Get
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}"} ]- 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.
- Run
Id string - Spark
Version string The Spark version utilized to run the application.
- State string
The current state of this run.
- Time
Created string The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Time
Updated string The date and time a application was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Total
Ocpu int The total number of oCPU requested by the run.
- Type 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.
- application
Id String The application ID.
- archive
Uri String An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- arguments List<String>
The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, wherename
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
- class
Name String The class for the application.
- compartment
Id 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.
- 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>
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. This name is not necessarily unique.
- driver
Shape String The VM shape for the driver. Sets the driver cores and memory.
- execute String
The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10
Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.- executor
Shape String The VM shape for the executors. Sets the executor cores and memory.
- 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>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
The ID of a run.
- language String
The Spark language.
- 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.
- metastore
Id String The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors Integer The number of executor VMs requested.
- 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,
null
will be returned and the caller should refer to the ownerPrincipalId value instead.- parameters
List<Get
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}"} ]- 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.
- run
Id String - spark
Version String The Spark version utilized to run the application.
- state String
The current state of this run.
- time
Created String The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated String The date and time a application 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.
- application
Id string The application ID.
- archive
Uri string An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- arguments string[]
The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, wherename
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
- class
Name string The class for the application.
- compartment
Id 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.
- 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}
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. This name is not necessarily unique.
- driver
Shape string The VM shape for the driver. Sets the driver cores and memory.
- execute string
The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10
Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.- executor
Shape string The VM shape for the executors. Sets the executor cores and memory.
- 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}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id string
The ID of a run.
- language string
The Spark language.
- 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.
- metastore
Id string The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors number The number of executor VMs requested.
- 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,
null
will be returned and the caller should refer to the ownerPrincipalId value instead.- parameters
Get
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}"} ]- 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.
- run
Id string - spark
Version string The Spark version utilized to run the application.
- state string
The current state of this run.
- time
Created string The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated string The date and time a application 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.
- application_
id str The application ID.
- archive_
uri str An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- arguments Sequence[str]
The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, wherename
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_ 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]
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.
- execute str
The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10
Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.- executor_
shape str The VM shape for the executors. Sets the executor cores and memory.
- file_
uri str An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Mapping[str, Any]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id str
The ID of a run.
- language str
The Spark language.
- lifecycle_
details str The detailed messages about the lifecycle state.
- logs_
bucket_ 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.
- metastore_
id str The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num_
executors int The number of executor VMs requested.
- 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,
null
will be returned and the caller should refer to the ownerPrincipalId value instead.- parameters
Get
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}"} ]- 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.
- 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 a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time_
updated str The date and time a application was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- total_
ocpu int The total number of oCPU requested by the run.
- type str
The Spark application processing type.
- warehouse_
bucket_ 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.
- application
Id String The application ID.
- archive
Uri String An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- arguments List<String>
The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, wherename
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
- class
Name String The class for the application.
- compartment
Id 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.
- 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>
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. This name is not necessarily unique.
- driver
Shape String The VM shape for the driver. Sets the driver cores and memory.
- execute String
The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10
Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only.- executor
Shape String The VM shape for the executors. Sets the executor cores and memory.
- 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>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
The ID of a run.
- language String
The Spark language.
- 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.
- metastore
Id String The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors Number The number of executor VMs requested.
- 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,
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}"} ]- 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.
- run
Id String - spark
Version String The Spark version utilized to run the application.
- state String
The current state of this run.
- time
Created String The date and time a application was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated String The date and time a application 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.
Supporting Types
GetInvokeRunParameter
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.