Application¶

class oci.data_flow.models.Application(**kwargs)¶

Bases: object

A Data Flow application object.

Attributes

`LANGUAGE_JAVA`	A constant which can be used with the language property of a Application.
`LANGUAGE_PYTHON`	A constant which can be used with the language property of a Application.
`LANGUAGE_SCALA`	A constant which can be used with the language property of a Application.
`LANGUAGE_SQL`	A constant which can be used with the language property of a Application.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Application.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Application.
`TYPE_BATCH`	A constant which can be used with the type property of a Application.
`TYPE_SESSION`	A constant which can be used with the type property of a Application.
`TYPE_STREAMING`	A constant which can be used with the type property of a Application.
`application_log_config`	Gets the application_log_config of this Application.
`archive_uri`	Gets the archive_uri of this Application.
`arguments`	Gets the arguments of this Application.
`class_name`	Gets the class_name of this Application.
`compartment_id`	[Required] Gets the compartment_id of this Application.
`configuration`	Gets the configuration of this Application.
`defined_tags`	Gets the defined_tags of this Application.
`description`	Gets the description of this Application.
`display_name`	[Required] Gets the display_name of this Application.
`driver_shape`	[Required] Gets the driver_shape of this Application.
`driver_shape_config`	Gets the driver_shape_config of this Application.
`execute`	Gets the execute of this Application.
`executor_shape`	[Required] Gets the executor_shape of this Application.
`executor_shape_config`	Gets the executor_shape_config of this Application.
`file_uri`	[Required] Gets the file_uri of this Application.
`freeform_tags`	Gets the freeform_tags of this Application.
`id`	[Required] Gets the id of this Application.
`idle_timeout_in_minutes`	Gets the idle_timeout_in_minutes of this Application.
`language`	[Required] Gets the language of this Application.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Application.
`logs_bucket_uri`	Gets the logs_bucket_uri of this Application.
`max_duration_in_minutes`	Gets the max_duration_in_minutes of this Application.
`metastore_id`	Gets the metastore_id of this Application.
`num_executors`	[Required] Gets the num_executors of this Application.
`owner_principal_id`	[Required] Gets the owner_principal_id of this Application.
`owner_user_name`	Gets the owner_user_name of this Application.
`parameters`	Gets the parameters of this Application.
`pool_id`	Gets the pool_id of this Application.
`private_endpoint_id`	Gets the private_endpoint_id of this Application.
`spark_version`	[Required] Gets the spark_version of this Application.
`time_created`	[Required] Gets the time_created of this Application.
`time_updated`	[Required] Gets the time_updated of this Application.
`type`	Gets the type of this Application.
`warehouse_bucket_uri`	Gets the warehouse_bucket_uri of this Application.

Methods

__init__(**kwargs) Initializes a new Application object with values from keyword arguments.

LANGUAGE_JAVA = 'JAVA'¶: A constant which can be used with the language property of a Application. This constant has a value of “JAVA”

LANGUAGE_PYTHON = 'PYTHON'¶: A constant which can be used with the language property of a Application. This constant has a value of “PYTHON”

LANGUAGE_SCALA = 'SCALA'¶: A constant which can be used with the language property of a Application. This constant has a value of “SCALA”

LANGUAGE_SQL = 'SQL'¶: A constant which can be used with the language property of a Application. This constant has a value of “SQL”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Application. This constant has a value of “INACTIVE”

TYPE_BATCH = 'BATCH'¶: A constant which can be used with the type property of a Application. This constant has a value of “BATCH”

TYPE_SESSION = 'SESSION'¶: A constant which can be used with the type property of a Application. This constant has a value of “SESSION”

TYPE_STREAMING = 'STREAMING'¶: A constant which can be used with the type property of a Application. This constant has a value of “STREAMING”

__init__(**kwargs)¶

Initializes a new Application object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

application_log_config (oci.data_flow.models.ApplicationLogConfig) – The value to assign to the application_log_config property of this Application.
archive_uri (str) – The value to assign to the archive_uri property of this Application.
arguments (list[str]) – The value to assign to the arguments property of this Application.
class_name (str) – The value to assign to the class_name property of this Application.
configuration (dict(str, str)) – The value to assign to the configuration property of this Application.
compartment_id (str) – The value to assign to the compartment_id property of this Application.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Application.
description (str) – The value to assign to the description property of this Application.
display_name (str) – The value to assign to the display_name property of this Application.
driver_shape (str) – The value to assign to the driver_shape property of this Application.
driver_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the driver_shape_config property of this Application.
execute (str) – The value to assign to the execute property of this Application.
executor_shape (str) – The value to assign to the executor_shape property of this Application.
executor_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the executor_shape_config property of this Application.
file_uri (str) – The value to assign to the file_uri property of this Application.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Application.
id (str) – The value to assign to the id property of this Application.
language (str) – The value to assign to the language property of this Application. Allowed values for this property are: “SCALA”, “JAVA”, “PYTHON”, “SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Application. Allowed values for this property are: “ACTIVE”, “DELETING”, “DELETED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
logs_bucket_uri (str) – The value to assign to the logs_bucket_uri property of this Application.
metastore_id (str) – The value to assign to the metastore_id property of this Application.
num_executors (int) – The value to assign to the num_executors property of this Application.
owner_principal_id (str) – The value to assign to the owner_principal_id property of this Application.
owner_user_name (str) – The value to assign to the owner_user_name property of this Application.
parameters (list[oci.data_flow.models.ApplicationParameter]) – The value to assign to the parameters property of this Application.
pool_id (str) – The value to assign to the pool_id property of this Application.
private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this Application.
spark_version (str) – The value to assign to the spark_version property of this Application.
time_created (datetime) – The value to assign to the time_created property of this Application.
time_updated (datetime) – The value to assign to the time_updated property of this Application.
type (str) – The value to assign to the type property of this Application. Allowed values for this property are: “BATCH”, “STREAMING”, “SESSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
warehouse_bucket_uri (str) – The value to assign to the warehouse_bucket_uri property of this Application.
max_duration_in_minutes (int) – The value to assign to the max_duration_in_minutes property of this Application.
idle_timeout_in_minutes (int) – The value to assign to the idle_timeout_in_minutes property of this Application.

application_log_config¶

Gets the application_log_config of this Application.

Returns:	The application_log_config of this Application.
Return type:	oci.data_flow.models.ApplicationLogConfig

archive_uri¶

Gets the archive_uri of this Application. 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.

Returns:	The archive_uri of this Application.
Return type:	str

arguments¶

Gets the arguments of this Application. 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”

Returns:	The arguments of this Application.
Return type:	list[str]

class_name¶

Gets the class_name of this Application. The class for the application.

Returns:	The class_name of this Application.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this Application. The OCID of a compartment.

Returns:	The compartment_id of this Application.
Return type:	str

configuration¶

Gets the configuration of this Application. 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.

Returns:	The configuration of this Application.
Return type:	dict(str, str)

defined_tags¶

Gets the defined_tags of this Application. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this Application.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this Application. A user-friendly description.

Returns:	The description of this Application.
Return type:	str

display_name¶

[Required] Gets the display_name of this Application. A user-friendly name. This name is not necessarily unique.

Returns:	The display_name of this Application.
Return type:	str

driver_shape¶

[Required] Gets the driver_shape of this Application. The VM shape for the driver. Sets the driver cores and memory.

Returns:	The driver_shape of this Application.
Return type:	str

driver_shape_config¶

Gets the driver_shape_config of this Application.

Returns:	The driver_shape_config of this Application.
Return type:	oci.data_flow.models.ShapeConfig

execute¶

Gets the execute of this Application. 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.

Returns:	The execute of this Application.
Return type:	str

executor_shape¶

[Required] Gets the executor_shape of this Application. The VM shape for the executors. Sets the executor cores and memory.

Returns:	The executor_shape of this Application.
Return type:	str

executor_shape_config¶

Gets the executor_shape_config of this Application.

Returns:	The executor_shape_config of this Application.
Return type:	oci.data_flow.models.ShapeConfig

file_uri¶

[Required] Gets the file_uri of this Application. 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.

Returns:	The file_uri of this Application.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this Application. 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”}

Returns:	The freeform_tags of this Application.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Application. The application ID.

Returns:	The id of this Application.
Return type:	str

idle_timeout_in_minutes¶

Gets the idle_timeout_in_minutes of this Application. 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)

Returns:	The idle_timeout_in_minutes of this Application.
Return type:	int

language¶

[Required] Gets the language of this Application. The Spark language.

Allowed values for this property are: “SCALA”, “JAVA”, “PYTHON”, “SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The language of this Application.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Application. The current state of this application.

Allowed values for this property are: “ACTIVE”, “DELETING”, “DELETED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Application.
Return type:	str

logs_bucket_uri¶

Gets the logs_bucket_uri of this Application. 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.

Returns:	The logs_bucket_uri of this Application.
Return type:	str

max_duration_in_minutes¶

Gets the max_duration_in_minutes of this Application. 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.

Returns:	The max_duration_in_minutes of this Application.
Return type:	int

metastore_id¶

Gets the metastore_id of this Application. The OCID of OCI Hive Metastore.

Returns:	The metastore_id of this Application.
Return type:	str

num_executors¶

[Required] Gets the num_executors of this Application. The number of executor VMs requested.

Returns:	The num_executors of this Application.
Return type:	int

owner_principal_id¶

[Required] Gets the owner_principal_id of this Application. The OCID of the user who created the resource.

Returns:	The owner_principal_id of this Application.
Return type:	str

owner_user_name¶

Gets the owner_user_name of this Application. 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.

Returns:	The owner_user_name of this Application.
Return type:	str

parameters¶

Gets the parameters of this Application. 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}”} ]

Returns:	The parameters of this Application.
Return type:	list[oci.data_flow.models.ApplicationParameter]

pool_id¶

Gets the pool_id of this Application. The OCID of a pool. Unique Id to indentify a dataflow pool resource.

Returns:	The pool_id of this Application.
Return type:	str

private_endpoint_id¶

Gets the private_endpoint_id of this Application. The OCID of a private endpoint.

Returns:	The private_endpoint_id of this Application.
Return type:	str

spark_version¶

[Required] Gets the spark_version of this Application. The Spark version utilized to run the application.

Returns:	The spark_version of this Application.
Return type:	str

time_created¶

[Required] Gets the time_created of this Application. The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns:	The time_created of this Application.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this Application. The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns:	The time_updated of this Application.
Return type:	datetime

type¶

Gets the type of this Application. The Spark application processing type.

Allowed values for this property are: “BATCH”, “STREAMING”, “SESSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this Application.
Return type:	str

warehouse_bucket_uri¶

Gets the warehouse_bucket_uri of this Application. 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.

Returns:	The warehouse_bucket_uri of this Application.
Return type:	str