Class Application

A Data Flow application object.

Inheritance

object

Application

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DataflowService.Models

Assembly: OCI.DotNetSDK.Dataflow.dll

Syntax

public class Application

Properties

ApplicationLogConfig

Declaration

[JsonProperty(PropertyName = "applicationLogConfig")]
public ApplicationLogConfig ApplicationLogConfig { get; set; }

Property Value

Type	Description
ApplicationLogConfig

ArchiveUri

Declaration

[JsonProperty(PropertyName = "archiveUri")]
public string ArchiveUri { get; set; }

Property Value

Type Description

Type	Description
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.

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

Declaration

[JsonProperty(PropertyName = "arguments")]
public List<string> Arguments { get; set; }

Property Value

Type Description

Type	Description
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"

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"

ClassName

Declaration

[JsonProperty(PropertyName = "className")]
public string ClassName { get; set; }

Property Value

Type	Description
string	The class for the application.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of a compartment.

Remarks

Required

Configuration

Declaration

[JsonProperty(PropertyName = "configuration")]
public Dictionary<string, string> Configuration { get; set; }

Property Value

Type	Description
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 isnot allowed to be overwritten will cause a 400 status to be returned.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, 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"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A user-friendly description.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. This name is not necessarily unique.

Remarks

Required

DriverShape

Declaration

[Required(ErrorMessage = "DriverShape is required.")]
[JsonProperty(PropertyName = "driverShape")]
public string DriverShape { get; set; }

Property Value

Type	Description
string	The VM shape for the driver. Sets the driver cores and memory.

Remarks

Required

DriverShapeConfig

Declaration

[JsonProperty(PropertyName = "driverShapeConfig")]
public ShapeConfig DriverShapeConfig { get; set; }

Property Value

Type	Description
ShapeConfig

Execute

Declaration

[JsonProperty(PropertyName = "execute")]
public string Execute { get; set; }

Property Value

Type Description

Type	Description
string	The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include `--class`, `--file`, `--jars`, `--conf`, `--py-files`, and main application file with arguments. Example: --jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,Data Flow service will use derived information from execute input only.

string

The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include --class, --file, --jars, --conf, --py-files, and main application file with arguments. Example: --jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,Data Flow service will use derived information from execute input only.

ExecutorShape

Declaration

[Required(ErrorMessage = "ExecutorShape is required.")]
[JsonProperty(PropertyName = "executorShape")]
public string ExecutorShape { get; set; }

Property Value

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

Remarks

Required

ExecutorShapeConfig

Declaration

[JsonProperty(PropertyName = "executorShapeConfig")]
public ShapeConfig ExecutorShapeConfig { get; set; }

Property Value

Type	Description
ShapeConfig

FileUri

Declaration

[Required(ErrorMessage = "FileUri is required.")]
[JsonProperty(PropertyName = "fileUri")]
public string FileUri { get; set; }

Property Value

Type	Description
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.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
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

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The application ID.

Remarks

Required

IdleTimeoutInMinutes

Declaration

[JsonProperty(PropertyName = "idleTimeoutInMinutes")]
public long? IdleTimeoutInMinutes { get; set; }

Property Value

Type	Description
long?	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

Declaration

[Required(ErrorMessage = "Language is required.")]
[JsonProperty(PropertyName = "language")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ApplicationLanguage? Language { get; set; }

Property Value

Type	Description
ApplicationLanguage?	The Spark language.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ApplicationLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
ApplicationLifecycleState?	The current state of this application.

Remarks

Required

LogsBucketUri

Declaration

[JsonProperty(PropertyName = "logsBucketUri")]
public string LogsBucketUri { get; set; }

Property Value

Type	Description
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

Declaration

[JsonProperty(PropertyName = "maxDurationInMinutes")]
public long? MaxDurationInMinutes { get; set; }

Property Value

Type	Description
long?	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

Declaration

[JsonProperty(PropertyName = "metastoreId")]
public string MetastoreId { get; set; }

Property Value

Type	Description
string	The OCID of OCI Hive Metastore.

NumExecutors

Declaration

[Required(ErrorMessage = "NumExecutors is required.")]
[JsonProperty(PropertyName = "numExecutors")]
public int? NumExecutors { get; set; }

Property Value

Type	Description
int?	The number of executor VMs requested.

Remarks

Required

OwnerPrincipalId

Declaration

[Required(ErrorMessage = "OwnerPrincipalId is required.")]
[JsonProperty(PropertyName = "ownerPrincipalId")]
public string OwnerPrincipalId { get; set; }

Property Value

Type	Description
string	The OCID of the user who created the resource.

Remarks

Required

OwnerUserName

Declaration

[JsonProperty(PropertyName = "ownerUserName")]
public string OwnerUserName { get; set; }

Property Value

Type	Description
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

Declaration

[JsonProperty(PropertyName = "parameters")]
public List<ApplicationParameter> Parameters { get; set; }

Property Value

Type	Description
List<ApplicationParameter>	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

Declaration

[JsonProperty(PropertyName = "poolId")]
public string PoolId { get; set; }

Property Value

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

PrivateEndpointId

Declaration

[JsonProperty(PropertyName = "privateEndpointId")]
public string PrivateEndpointId { get; set; }

Property Value

Type	Description
string	The OCID of a private endpoint.

SparkVersion

Declaration

[Required(ErrorMessage = "SparkVersion is required.")]
[JsonProperty(PropertyName = "sparkVersion")]
public string SparkVersion { get; set; }

Property Value

Type	Description
string	The Spark version utilized to run the application.

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Remarks

Required

Type

Declaration

[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ApplicationType? Type { get; set; }

Property Value

Type	Description
ApplicationType?	The Spark application processing type.

WarehouseBucketUri

Declaration

[JsonProperty(PropertyName = "warehouseBucketUri")]
public string WarehouseBucketUri { get; set; }

Property Value

Type	Description
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.