"create"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


Description
===========

Creates a run for an application.


Usage
=====

   oci data-flow run create [OPTIONS]


Required Parameters
===================

--application-id [text]

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.

--compartment-id, -c [text]

The OCID of a compartment.

--display-name [text]

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.


Optional Parameters
===================

--arguments [complex type]

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”* This is a complex type whose value must be valid JSON. The
value can be provided as a string on the command line or passed in as
a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--configuration [complex type]

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. This
is a complex type whose value must be valid JSON. The value can be
provided as a string on the command line or passed in as a file using
the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags. Example:
*{“Operations”: {“CostCenter”: “42”}}* This is a complex type whose
value must be valid JSON. The value can be provided as a string on the
command line or passed in as a file using the file://path/to/file
syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--driver-shape [text]

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

--executor-shape [text]

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

--freeform-tags [complex type]

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”}* This is a complex
type whose value must be valid JSON. The value can be provided as a
string on the command line or passed in as a file using the
file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--logs-bucket-uri [text]

An Oracle Cloud Infrastructure URI of the bucket where the Spark job
logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/hdfsconnector.htm#uriformat.

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state
defined by "--wait-for-state". Defaults to 1200 seconds.

--metastore-id [text]

The OCID of OCI Hive Metastore.

--num-executors [integer]

The number of executor VMs requested.

--parameters [complex type]

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}”} ]

This option is a JSON list with items of type ApplicationParameter.
For documentation on ApplicationParameter please see our API
reference: https://docs.cloud.oracle.com/api/#/en/dataflow/20200129/d
atatypes/ApplicationParameter. This is a complex type whose value must
be valid JSON. The value can be provided as a string on the command
line or passed in as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--spark-version [text]

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.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a
defined lifecycle state. Specify this option to perform the action and
then wait until the resource reaches a given lifecycle state. Multiple
states can be specified, returning on the first state. For example, "
--wait-for-state" SUCCEEDED "--wait-for-state" FAILED would return on
whichever lifecycle state is reached first. If timeout is reached, a
return code of 2 is returned. For any other error, a return code of 1
is returned.

Accepted values are:

   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the resource to
see if it has reached the lifecycle state defined by "--wait-for-
state". Defaults to 30 seconds.

--warehouse-bucket-uri [text]

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.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-rc-file", "--
config-file", "--debug", "--defaults-file", "--endpoint", "--generate-
full-command-json-input", "--generate-param-json-input", "--help", "--
latest-version", "--max-retries", "--no-retry", "--opc-client-request-
id", "--opc-request-id", "--output", "--profile", "--query", "--raw-
output", "--region", "--release-info", "--request-id", "--version",
"-?", "-d", "-h", "-v"


Examples
========

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/application/create.html#cmdoption-compartment-id
       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/application/create.html#cmdoption-display-name
       export driver_shape=<substitute-value-of-driver_shape> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/application/create.html#cmdoption-driver-shape
       export executor_shape=<substitute-value-of-executor_shape> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/application/create.html#cmdoption-executor-shape
       export file_uri=<substitute-value-of-file_uri> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/application/create.html#cmdoption-file-uri
       export language=<substitute-value-of-language> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/application/create.html#cmdoption-language
       export num_executors=<substitute-value-of-num_executors> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/application/create.html#cmdoption-num-executors
       export spark_version=<substitute-value-of-spark_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-flow/application/create.html#cmdoption-spark-version

       application_id=$(oci data-flow application create --compartment-id $compartment_id --display-name $display_name --driver-shape $driver_shape --executor-shape $executor_shape --file-uri $file_uri --language $language --num-executors $num_executors --spark-version $spark_version --query data.id --raw-output)

       oci data-flow run create --application-id $application_id --compartment-id $compartment_id --display-name $display_name
