Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateApplicationDetails

The create application details.

Properties

Optional applicationLogConfig

applicationLogConfig: model.ApplicationLogConfig

Optional archiveUri

archiveUri: undefined | string

A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, {@code 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.

Optional arguments

arguments: Array<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 {@code Service Api Spec}, where {@code name} is the name of the parameter. Example: {@code [ "--input", "${input_file}", "--name", "John Doe" ]} If "input_file" has a value of "mydata.xml", then the value above will be translated to {@code --input mydata.xml --name "John Doe"}

Optional className

className: undefined | string

The class for the application.

compartmentId

compartmentId: string

The OCID of a compartment.

Optional configuration

configuration: undefined | 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.

Optional definedTags

definedTags: undefined | object

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

Optional description

description: undefined | string

A user-friendly description. Avoid entering confidential information.

displayName

displayName: string

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

driverShape

driverShape: string

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

Optional driverShapeConfig

driverShapeConfig: model.ShapeConfig

Optional execute

execute: undefined | 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 {@code --class}{@code , }{@code --file}{@code , }{@code --jars}{@code , }{@code --conf}{@code , }{@code --py-files}{@code , and main application file with arguments. Example: }{@code --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

executorShape: string

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

Optional executorShapeConfig

executorShapeConfig: model.ShapeConfig

Optional fileUri

fileUri: undefined | 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.

Optional freeformTags

freeformTags: undefined | 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: {@code {"Department": "Finance"}}

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

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 {@code SESSION}. Default value is 2880 minutes (2 days) Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

language

The Spark language.

Optional logsBucketUri

logsBucketUri: undefined | 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.

Optional maxDurationInMinutes

maxDurationInMinutes: undefined | number

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 {@code IN_PROGRESS} state. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional metastoreId

metastoreId: undefined | string

The OCID of OCI Hive Metastore.

numExecutors

numExecutors: number

The number of executor VMs requested. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parameters

An array of name/value pairs used to fill placeholders found in properties like {@code 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}"} ]

Optional poolId

poolId: undefined | string

The OCID of a pool. Unique Id to indentify a dataflow pool resource.

Optional privateEndpointId

privateEndpointId: undefined | string

The OCID of a private endpoint.

sparkVersion

sparkVersion: string

The Spark version utilized to run the application.

Optional type

type: model.ApplicationType

The Spark application processing type.

Optional warehouseBucketUri

warehouseBucketUri: undefined | 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.

Functions

getDeserializedJsonObj

getJsonObj