UpdateApplicationDetails¶
-
class
oci.data_flow.models.
UpdateApplicationDetails
(**kwargs)¶ Bases:
object
The update application details.
Attributes
LANGUAGE_JAVA
A constant which can be used with the language property of a UpdateApplicationDetails. LANGUAGE_PYTHON
A constant which can be used with the language property of a UpdateApplicationDetails. LANGUAGE_SCALA
A constant which can be used with the language property of a UpdateApplicationDetails. LANGUAGE_SQL
A constant which can be used with the language property of a UpdateApplicationDetails. archive_uri
Gets the archive_uri of this UpdateApplicationDetails. arguments
Gets the arguments of this UpdateApplicationDetails. class_name
Gets the class_name of this UpdateApplicationDetails. configuration
Gets the configuration of this UpdateApplicationDetails. defined_tags
Gets the defined_tags of this UpdateApplicationDetails. description
Gets the description of this UpdateApplicationDetails. display_name
Gets the display_name of this UpdateApplicationDetails. driver_shape
Gets the driver_shape of this UpdateApplicationDetails. execute
Gets the execute of this UpdateApplicationDetails. executor_shape
Gets the executor_shape of this UpdateApplicationDetails. file_uri
Gets the file_uri of this UpdateApplicationDetails. freeform_tags
Gets the freeform_tags of this UpdateApplicationDetails. language
Gets the language of this UpdateApplicationDetails. logs_bucket_uri
Gets the logs_bucket_uri of this UpdateApplicationDetails. metastore_id
Gets the metastore_id of this UpdateApplicationDetails. num_executors
Gets the num_executors of this UpdateApplicationDetails. parameters
Gets the parameters of this UpdateApplicationDetails. private_endpoint_id
Gets the private_endpoint_id of this UpdateApplicationDetails. spark_version
Gets the spark_version of this UpdateApplicationDetails. warehouse_bucket_uri
Gets the warehouse_bucket_uri of this UpdateApplicationDetails. Methods
__init__
(**kwargs)Initializes a new UpdateApplicationDetails object with values from keyword arguments. -
LANGUAGE_JAVA
= 'JAVA'¶ A constant which can be used with the language property of a UpdateApplicationDetails. This constant has a value of “JAVA”
-
LANGUAGE_PYTHON
= 'PYTHON'¶ A constant which can be used with the language property of a UpdateApplicationDetails. This constant has a value of “PYTHON”
-
LANGUAGE_SCALA
= 'SCALA'¶ A constant which can be used with the language property of a UpdateApplicationDetails. This constant has a value of “SCALA”
-
LANGUAGE_SQL
= 'SQL'¶ A constant which can be used with the language property of a UpdateApplicationDetails. This constant has a value of “SQL”
-
__init__
(**kwargs)¶ Initializes a new UpdateApplicationDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - class_name (str) – The value to assign to the class_name property of this UpdateApplicationDetails.
- file_uri (str) – The value to assign to the file_uri property of this UpdateApplicationDetails.
- spark_version (str) – The value to assign to the spark_version property of this UpdateApplicationDetails.
- language (str) – The value to assign to the language property of this UpdateApplicationDetails. Allowed values for this property are: “SCALA”, “JAVA”, “PYTHON”, “SQL”
- archive_uri (str) – The value to assign to the archive_uri property of this UpdateApplicationDetails.
- arguments (list[str]) – The value to assign to the arguments property of this UpdateApplicationDetails.
- configuration (dict(str, str)) – The value to assign to the configuration property of this UpdateApplicationDetails.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateApplicationDetails.
- description (str) – The value to assign to the description property of this UpdateApplicationDetails.
- display_name (str) – The value to assign to the display_name property of this UpdateApplicationDetails.
- driver_shape (str) – The value to assign to the driver_shape property of this UpdateApplicationDetails.
- execute (str) – The value to assign to the execute property of this UpdateApplicationDetails.
- executor_shape (str) – The value to assign to the executor_shape property of this UpdateApplicationDetails.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateApplicationDetails.
- logs_bucket_uri (str) – The value to assign to the logs_bucket_uri property of this UpdateApplicationDetails.
- metastore_id (str) – The value to assign to the metastore_id property of this UpdateApplicationDetails.
- num_executors (int) – The value to assign to the num_executors property of this UpdateApplicationDetails.
- parameters (list[oci.data_flow.models.ApplicationParameter]) – The value to assign to the parameters property of this UpdateApplicationDetails.
- private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this UpdateApplicationDetails.
- warehouse_bucket_uri (str) – The value to assign to the warehouse_bucket_uri property of this UpdateApplicationDetails.
-
archive_uri
¶ Gets the archive_uri of this UpdateApplicationDetails. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution 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 UpdateApplicationDetails. Return type: str
-
arguments
¶ Gets the arguments of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: list[str]
-
class_name
¶ Gets the class_name of this UpdateApplicationDetails. The class for the application.
Returns: The class_name of this UpdateApplicationDetails. Return type: str
-
configuration
¶ Gets the configuration of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: dict(str, str)
Gets the defined_tags of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: dict(str, dict(str, object))
-
description
¶ Gets the description of this UpdateApplicationDetails. A user-friendly description. Avoid entering confidential information.
Returns: The description of this UpdateApplicationDetails. Return type: str
-
display_name
¶ Gets the display_name of this UpdateApplicationDetails. A user-friendly name. It does not have to be unique. Avoid entering confidential information.
Returns: The display_name of this UpdateApplicationDetails. Return type: str
-
driver_shape
¶ Gets the driver_shape of this UpdateApplicationDetails. The VM shape for the driver. Sets the driver cores and memory.
Returns: The driver_shape of this UpdateApplicationDetails. Return type: str
-
execute
¶ Gets the execute of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: str
-
executor_shape
¶ Gets the executor_shape of this UpdateApplicationDetails. The VM shape for the executors. Sets the executor cores and memory.
Returns: The executor_shape of this UpdateApplicationDetails. Return type: str
-
file_uri
¶ Gets the file_uri of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: str
Gets the freeform_tags of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: dict(str, str)
-
language
¶ Gets the language of this UpdateApplicationDetails. The Spark language.
Allowed values for this property are: “SCALA”, “JAVA”, “PYTHON”, “SQL”
Returns: The language of this UpdateApplicationDetails. Return type: str
-
logs_bucket_uri
¶ Gets the logs_bucket_uri of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: str
-
metastore_id
¶ Gets the metastore_id of this UpdateApplicationDetails. The OCID of OCI Hive Metastore.
Returns: The metastore_id of this UpdateApplicationDetails. Return type: str
-
num_executors
¶ Gets the num_executors of this UpdateApplicationDetails. The number of executor VMs requested.
Returns: The num_executors of this UpdateApplicationDetails. Return type: int
-
parameters
¶ Gets the parameters of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: list[oci.data_flow.models.ApplicationParameter]
-
private_endpoint_id
¶ Gets the private_endpoint_id of this UpdateApplicationDetails. The OCID of a private endpoint.
Returns: The private_endpoint_id of this UpdateApplicationDetails. Return type: str
-
spark_version
¶ Gets the spark_version of this UpdateApplicationDetails. The Spark version utilized to run the application.
Returns: The spark_version of this UpdateApplicationDetails. Return type: str
-
warehouse_bucket_uri
¶ Gets the warehouse_bucket_uri of this UpdateApplicationDetails. 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 UpdateApplicationDetails. Return type: str
-