Oracle Cloud Infrastructure v2.12.0 published on Friday, Oct 11, 2024 by Pulumi
oci.DataFlow.getApplication
Explore with Pulumi AI
This data source provides details about a specific Application resource in Oracle Cloud Infrastructure Data Flow service.
Retrieves an application using an applicationId
.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testApplication = oci.DataFlow.getApplication({
applicationId: testApplicationOciDataflowApplication.id,
});
import pulumi
import pulumi_oci as oci
test_application = oci.DataFlow.get_application(application_id=test_application_oci_dataflow_application["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DataFlow"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := DataFlow.GetApplication(ctx, &dataflow.GetApplicationArgs{
ApplicationId: testApplicationOciDataflowApplication.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 testApplication = Oci.DataFlow.GetApplication.Invoke(new()
{
ApplicationId = testApplicationOciDataflowApplication.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.GetApplicationArgs;
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 testApplication = DataFlowFunctions.getApplication(GetApplicationArgs.builder()
.applicationId(testApplicationOciDataflowApplication.id())
.build());
}
}
variables:
testApplication:
fn::invoke:
Function: oci:DataFlow:getApplication
Arguments:
applicationId: ${testApplicationOciDataflowApplication.id}
Using getApplication
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 getApplication(args: GetApplicationArgs, opts?: InvokeOptions): Promise<GetApplicationResult>
function getApplicationOutput(args: GetApplicationOutputArgs, opts?: InvokeOptions): Output<GetApplicationResult>
def get_application(application_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetApplicationResult
def get_application_output(application_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetApplicationResult]
func GetApplication(ctx *Context, args *GetApplicationArgs, opts ...InvokeOption) (*GetApplicationResult, error)
func GetApplicationOutput(ctx *Context, args *GetApplicationOutputArgs, opts ...InvokeOption) GetApplicationResultOutput
> Note: This function is named GetApplication
in the Go SDK.
public static class GetApplication
{
public static Task<GetApplicationResult> InvokeAsync(GetApplicationArgs args, InvokeOptions? opts = null)
public static Output<GetApplicationResult> Invoke(GetApplicationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApplicationResult> getApplication(GetApplicationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:DataFlow/getApplication:getApplication
arguments:
# arguments dictionary
The following arguments are supported:
- Application
Id string - The unique ID for an application.
- Application
Id string - The unique ID for an application.
- application
Id String - The unique ID for an application.
- application
Id string - The unique ID for an application.
- application_
id str - The unique ID for an application.
- application
Id String - The unique ID for an application.
getApplication Result
The following output properties are available:
- Application
Id string - Application
Log List<GetConfigs Application Application Log Config> - Logging details of Application logs for Data Flow Run.
- Archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip
. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. - Arguments List<string>
- The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, 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"
- Class
Name string - The class for the application.
- Compartment
Id string - The OCID of a compartment.
- Configuration Dictionary<string, string>
- The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- A user-friendly description.
- 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.
- Driver
Shape List<GetConfigs Application Driver Shape Config> - This is used to configure the shape of the driver or executor if a flexible shape is used.
- Execute string
- The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 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.
- Executor
Shape List<GetConfigs Application Executor Shape Config> - This is used to configure the shape of the driver or executor if a flexible shape is used.
- File
Uri string - An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Dictionary<string, string>
- 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 application ID.
- Idle
Timeout stringIn Minutes - 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.
- Logs
Bucket stringUri - An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Max
Duration stringIn Minutes - 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 string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- Num
Executors int - The number of executor VMs requested.
- 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
Application Parameter> - An array of name/value pairs used to fill placeholders found in properties like
Application.arguments
. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] - Pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- Private
Endpoint stringId - The OCID of a private endpoint.
- Spark
Version string - The Spark version utilized to run the application.
- State string
- The current state of this application.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Time
Updated string - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- 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 - Application
Log []GetConfigs Application Application Log Config - Logging details of Application logs for Data Flow Run.
- Archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip
. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. - Arguments []string
- The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, 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"
- Class
Name string - The class for the application.
- Compartment
Id string - The OCID of a compartment.
- Configuration map[string]string
- The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- A user-friendly description.
- 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.
- Driver
Shape []GetConfigs Application Driver Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- Execute string
- The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 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.
- Executor
Shape []GetConfigs Application Executor Shape Config - This is used to configure the shape of the driver or executor if a flexible shape is used.
- File
Uri string - An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- map[string]string
- 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 application ID.
- Idle
Timeout stringIn Minutes - 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.
- Logs
Bucket stringUri - An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Max
Duration stringIn Minutes - 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 string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- Num
Executors int - The number of executor VMs requested.
- 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
Application Parameter - An array of name/value pairs used to fill placeholders found in properties like
Application.arguments
. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] - Pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- Private
Endpoint stringId - The OCID of a private endpoint.
- Spark
Version string - The Spark version utilized to run the application.
- State string
- The current state of this application.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- Time
Updated string - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- 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 - application
Log List<GetConfigs Application Application Log Config> - Logging details of Application logs for Data Flow Run.
- archive
Uri String - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip
. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. - arguments List<String>
- The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, 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"
- class
Name String - The class for the application.
- compartment
Id String - The OCID of a compartment.
- configuration Map<String,String>
- The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- A user-friendly description.
- 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.
- driver
Shape List<GetConfigs Application Driver Shape Config> - This is used to configure the shape of the driver or executor if a flexible shape is used.
- execute String
- The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 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.
- executor
Shape List<GetConfigs Application Executor Shape Config> - This is used to configure the shape of the driver or executor if a flexible shape is used.
- file
Uri String - An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Map<String,String>
- 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 application ID.
- idle
Timeout StringIn Minutes - 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.
- logs
Bucket StringUri - An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- max
Duration StringIn Minutes - 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 String - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors Integer - The number of executor VMs requested.
- 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
Application Parameter> - An array of name/value pairs used to fill placeholders found in properties like
Application.arguments
. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] - pool
Id String - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- private
Endpoint StringId - The OCID of a private endpoint.
- spark
Version String - The Spark version utilized to run the application.
- state String
- The current state of this application.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated String - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- 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 - application
Log GetConfigs Application Application Log Config[] - Logging details of Application logs for Data Flow Run.
- archive
Uri string - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip
. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. - arguments string[]
- The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, 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"
- class
Name string - The class for the application.
- compartment
Id string - The OCID of a compartment.
- configuration {[key: string]: string}
- The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description string
- A user-friendly description.
- 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.
- driver
Shape GetConfigs Application Driver Shape Config[] - This is used to configure the shape of the driver or executor if a flexible shape is used.
- execute string
- The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include
--class
,--file
,--jars
,--conf
,--py-files
, and main application file with arguments. Example:--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 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.
- executor
Shape GetConfigs Application Executor Shape Config[] - This is used to configure the shape of the driver or executor if a flexible shape is used.
- file
Uri string - An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- {[key: string]: string}
- 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 application ID.
- idle
Timeout stringIn Minutes - 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.
- logs
Bucket stringUri - An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- max
Duration stringIn Minutes - 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 string - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors number - The number of executor VMs requested.
- 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
Application Parameter[] - An array of name/value pairs used to fill placeholders found in properties like
Application.arguments
. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] - pool
Id string - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- private
Endpoint stringId - The OCID of a private endpoint.
- spark
Version string - The Spark version utilized to run the application.
- state string
- The current state of this application.
- time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated string - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- 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 - application_
log_ Sequence[dataflow.configs Get Application Application Log Config] - 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
, 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"
- class_
name str - The class for the application.
- compartment_
id str - The OCID of a compartment.
- configuration Mapping[str, str]
- The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description str
- A user-friendly description.
- 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_ Sequence[dataflow.configs Get Application Driver Shape Config] - 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_ Sequence[dataflow.configs Get Application Executor Shape Config] - This is used to configure the shape of the driver or executor if a flexible shape is used.
- file_
uri str - An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Mapping[str, str]
- 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 application ID.
- idle_
timeout_ strin_ minutes - 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.
- logs_
bucket_ struri - An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- max_
duration_ strin_ minutes - 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.
- 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
Sequence[dataflow.
Get Application Parameter] - An array of name/value pairs used to fill placeholders found in properties like
Application.arguments
. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] - pool_
id str - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- private_
endpoint_ strid - The OCID of a private endpoint.
- spark_
version str - The Spark version utilized to run the application.
- state str
- The current state of this application.
- 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
- 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 - application
Log List<Property Map>Configs - Logging details of Application logs for Data Flow Run.
- archive
Uri String - A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example,
oci://path/to/a.zip,oci://path/to/b.zip
. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. - arguments List<String>
- The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
Service Api Spec
, 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"
- class
Name String - The class for the application.
- compartment
Id String - The OCID of a compartment.
- configuration Map<String>
- The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- A user-friendly description.
- 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.
- driver
Shape List<Property Map>Configs - 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. - executor
Shape String - The VM shape for the executors. Sets the executor cores and memory.
- executor
Shape List<Property Map>Configs - This is used to configure the shape of the driver or executor if a flexible shape is used.
- file
Uri String - An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- Map<String>
- 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 application ID.
- idle
Timeout StringIn Minutes - 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.
- logs
Bucket StringUri - An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
- max
Duration StringIn Minutes - 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 String - The OCID of Oracle Cloud Infrastructure Hive Metastore.
- num
Executors Number - The number of executor VMs requested.
- 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}"} ] - pool
Id String - The OCID of a pool. Unique Id to indentify a dataflow pool resource.
- private
Endpoint StringId - The OCID of a private endpoint.
- spark
Version String - The Spark version utilized to run the application.
- state String
- The current state of this application.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- time
Updated String - The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2018-04-03T21:10:29.600Z
- 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
GetApplicationApplicationLogConfig
- Log
Group stringId - The log group id for where log objects will be for Data Flow Runs.
- Log
Id string - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- Log
Group stringId - The log group id for where log objects will be for Data Flow Runs.
- Log
Id string - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- log
Group StringId - The log group id for where log objects will be for Data Flow Runs.
- log
Id String - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- log
Group stringId - The log group id for where log objects will be for Data Flow Runs.
- log
Id string - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- log_
group_ strid - The log group id for where log objects will be for Data Flow Runs.
- log_
id str - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
- log
Group StringId - The log group id for where log objects will be for Data Flow Runs.
- log
Id String - The log id of the log object the Application Logs of Data Flow Run will be shipped to.
GetApplicationDriverShapeConfig
- Memory
In doubleGbs - The amount of memory used for the driver or executors.
- Ocpus double
- The total number of OCPUs used for the driver or executors. See here for details.
- Memory
In float64Gbs - The amount of memory used for the driver or executors.
- Ocpus float64
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In DoubleGbs - The amount of memory used for the driver or executors.
- ocpus Double
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In numberGbs - The amount of memory used for the driver or executors.
- ocpus number
- The total number of OCPUs used for the driver or executors. See here for details.
- memory_
in_ floatgbs - The amount of memory used for the driver or executors.
- ocpus float
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In NumberGbs - The amount of memory used for the driver or executors.
- ocpus Number
- The total number of OCPUs used for the driver or executors. See here for details.
GetApplicationExecutorShapeConfig
- Memory
In doubleGbs - The amount of memory used for the driver or executors.
- Ocpus double
- The total number of OCPUs used for the driver or executors. See here for details.
- Memory
In float64Gbs - The amount of memory used for the driver or executors.
- Ocpus float64
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In DoubleGbs - The amount of memory used for the driver or executors.
- ocpus Double
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In numberGbs - The amount of memory used for the driver or executors.
- ocpus number
- The total number of OCPUs used for the driver or executors. See here for details.
- memory_
in_ floatgbs - The amount of memory used for the driver or executors.
- ocpus float
- The total number of OCPUs used for the driver or executors. See here for details.
- memory
In NumberGbs - The amount of memory used for the driver or executors.
- ocpus Number
- The total number of OCPUs used for the driver or executors. See here for details.
GetApplicationParameter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.