Class CreateRunDetails

The create run details. The following properties are optional and override the default values set in the associated application:

applicationId
archiveUri
applicationLogConfig
arguments
configuration
definedTags
displayName
driverShape
execute
executorShape
freeformTags
logsBucketUri
metastoreId
numExecutors
parameters
sparkVersion
warehouseBucketUri It is expected that either the applicationId or the execute parameter is specified; but not both. If both or none are set, a Bad Request (HTTP 400) status will be sent as the response. If an appicationId is not specified, then a value for the execute parameter is expected. Using data parsed from the value, a new application will be created and assicated with the new run. See information on the execute parameter for details on the format of this parameter.
The optional parameter spark version can only be specified when using the execute parameter. If it is not specified when using the execute parameter, the latest version will be used as default. If the execute parameter is not used, the spark version will be taken from the associated application.
If displayName is not specified, it will be derived from the displayName of associated application or set by API using fileUri's application file name. Once a run is created, its properties (except for definedTags and freeformTags) cannot be changed. If the parent application's properties (including definedTags and freeformTags) are updated, the corresponding properties of the run will not update.

Inheritance

object

CreateRunDetails

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 CreateRunDetails

Properties

ApplicationId

Declaration

[JsonProperty(PropertyName = "applicationId")]
public string ApplicationId { get; set; }

Property Value

Type	Description
string	The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.

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"

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"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.

DriverShape

Declaration

[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.

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

[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.

ExecutorShapeConfig

Declaration

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

Property Value

Type	Description
ShapeConfig

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"}

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)

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

[JsonProperty(PropertyName = "numExecutors")]
public int? NumExecutors { get; set; }

Property Value

Type	Description
int?	The number of executor VMs requested.

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.

SparkVersion

Declaration

[JsonProperty(PropertyName = "sparkVersion")]
public string SparkVersion { get; set; }

Property Value

Type	Description
string	The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.

Type

Declaration

[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(StringEnumConverter))]
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.