Run¶

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

Bases: object

A run object.

Attributes:

`LANGUAGE_JAVA`	A constant which can be used with the language property of a Run.
`LANGUAGE_PYTHON`	A constant which can be used with the language property of a Run.
`LANGUAGE_SCALA`	A constant which can be used with the language property of a Run.
`LANGUAGE_SQL`	A constant which can be used with the language property of a Run.
`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a Run.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a Run.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a Run.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Run.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a Run.
`LIFECYCLE_STATE_STOPPED`	A constant which can be used with the lifecycle_state property of a Run.
`LIFECYCLE_STATE_STOPPING`	A constant which can be used with the lifecycle_state property of a Run.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a Run.
`TYPE_BATCH`	A constant which can be used with the type property of a Run.
`TYPE_SESSION`	A constant which can be used with the type property of a Run.
`TYPE_STREAMING`	A constant which can be used with the type property of a Run.
`application_id`	[Required] Gets the application_id of this Run.
`application_log_config`	Gets the application_log_config of this Run.
`archive_uri`	Gets the archive_uri of this Run.
`arguments`	Gets the arguments of this Run.
`class_name`	Gets the class_name of this Run.
`compartment_id`	[Required] Gets the compartment_id of this Run.
`configuration`	Gets the configuration of this Run.
`data_read_in_bytes`	Gets the data_read_in_bytes of this Run.
`data_written_in_bytes`	Gets the data_written_in_bytes of this Run.
`defined_tags`	Gets the defined_tags of this Run.
`display_name`	Gets the display_name of this Run.
`driver_shape`	[Required] Gets the driver_shape of this Run.
`driver_shape_config`	Gets the driver_shape_config of this Run.
`execute`	Gets the execute of this Run.
`executor_shape`	[Required] Gets the executor_shape of this Run.
`executor_shape_config`	Gets the executor_shape_config of this Run.
`file_uri`	[Required] Gets the file_uri of this Run.
`freeform_tags`	Gets the freeform_tags of this Run.
`id`	[Required] Gets the id of this Run.
`idle_timeout_in_minutes`	Gets the idle_timeout_in_minutes of this Run.
`language`	[Required] Gets the language of this Run.
`lifecycle_details`	Gets the lifecycle_details of this Run.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Run.
`logs_bucket_uri`	Gets the logs_bucket_uri of this Run.
`max_duration_in_minutes`	Gets the max_duration_in_minutes of this Run.
`metastore_id`	Gets the metastore_id of this Run.
`num_executors`	[Required] Gets the num_executors of this Run.
`opc_request_id`	Gets the opc_request_id of this Run.
`owner_principal_id`	Gets the owner_principal_id of this Run.
`owner_user_name`	Gets the owner_user_name of this Run.
`parameters`	Gets the parameters of this Run.
`pool_id`	Gets the pool_id of this Run.
`private_endpoint_dns_zones`	Gets the private_endpoint_dns_zones of this Run.
`private_endpoint_id`	Gets the private_endpoint_id of this Run.
`private_endpoint_max_host_count`	Gets the private_endpoint_max_host_count of this Run.
`private_endpoint_nsg_ids`	Gets the private_endpoint_nsg_ids of this Run.
`private_endpoint_subnet_id`	Gets the private_endpoint_subnet_id of this Run.
`run_duration_in_milliseconds`	Gets the run_duration_in_milliseconds of this Run.
`spark_version`	[Required] Gets the spark_version of this Run.
`time_created`	[Required] Gets the time_created of this Run.
`time_updated`	[Required] Gets the time_updated of this Run.
`total_o_cpu`	Gets the total_o_cpu of this Run.
`type`	Gets the type of this Run.
`warehouse_bucket_uri`	Gets the warehouse_bucket_uri of this Run.

Methods:

__init__(**kwargs)

Initializes a new Run object with values from keyword arguments.

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

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

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

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

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a Run. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a Run. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a Run. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Run. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a Run. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_STOPPED = 'STOPPED'¶: A constant which can be used with the lifecycle_state property of a Run. This constant has a value of “STOPPED”

LIFECYCLE_STATE_STOPPING = 'STOPPING'¶: A constant which can be used with the lifecycle_state property of a Run. This constant has a value of “STOPPING”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a Run. This constant has a value of “SUCCEEDED”

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

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

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

__init__(**kwargs)¶

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

Parameters

archive_uri (str) – The value to assign to the archive_uri property of this Run.
arguments (list[str]) – The value to assign to the arguments property of this Run.
application_id (str) – The value to assign to the application_id property of this Run.
application_log_config (oci.data_flow.models.ApplicationLogConfig) – The value to assign to the application_log_config property of this Run.
class_name (str) – The value to assign to the class_name property of this Run.
compartment_id (str) – The value to assign to the compartment_id property of this Run.
configuration (dict(str, str)) – The value to assign to the configuration property of this Run.
data_read_in_bytes (int) – The value to assign to the data_read_in_bytes property of this Run.
data_written_in_bytes (int) – The value to assign to the data_written_in_bytes property of this Run.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Run.
display_name (str) – The value to assign to the display_name property of this Run.
driver_shape (str) – The value to assign to the driver_shape property of this Run.
driver_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the driver_shape_config property of this Run.
execute (str) – The value to assign to the execute property of this Run.
executor_shape (str) – The value to assign to the executor_shape property of this Run.
executor_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the executor_shape_config property of this Run.
file_uri (str) – The value to assign to the file_uri property of this Run.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Run.
id (str) – The value to assign to the id property of this Run.
language (str) – The value to assign to the language property of this Run. 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_details (str) – The value to assign to the lifecycle_details property of this Run.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Run. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “FAILED”, “SUCCEEDED”, “STOPPING”, “STOPPED”, ‘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 Run.
metastore_id (str) – The value to assign to the metastore_id property of this Run.
num_executors (int) – The value to assign to the num_executors property of this Run.
opc_request_id (str) – The value to assign to the opc_request_id property of this Run.
owner_principal_id (str) – The value to assign to the owner_principal_id property of this Run.
owner_user_name (str) – The value to assign to the owner_user_name property of this Run.
parameters (list[oci.data_flow.models.ApplicationParameter]) – The value to assign to the parameters property of this Run.
pool_id (str) – The value to assign to the pool_id property of this Run.
private_endpoint_dns_zones (list[str]) – The value to assign to the private_endpoint_dns_zones property of this Run.
private_endpoint_max_host_count (int) – The value to assign to the private_endpoint_max_host_count property of this Run.
private_endpoint_nsg_ids (list[str]) – The value to assign to the private_endpoint_nsg_ids property of this Run.
private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this Run.
private_endpoint_subnet_id (str) – The value to assign to the private_endpoint_subnet_id property of this Run.
run_duration_in_milliseconds (int) – The value to assign to the run_duration_in_milliseconds property of this Run.
spark_version (str) – The value to assign to the spark_version property of this Run.
time_created (datetime) – The value to assign to the time_created property of this Run.
time_updated (datetime) – The value to assign to the time_updated property of this Run.
total_o_cpu (int) – The value to assign to the total_o_cpu property of this Run.
type (str) – The value to assign to the type property of this Run. 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 Run.
max_duration_in_minutes (int) – The value to assign to the max_duration_in_minutes property of this Run.
idle_timeout_in_minutes (int) – The value to assign to the idle_timeout_in_minutes property of this Run.

property application_id¶

[Required] Gets the application_id of this Run. The application ID.

Returns: The application_id of this Run.
Return type: str

property application_log_config¶

Gets the application_log_config of this Run.

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

property archive_uri¶

Gets the archive_uri of this Run. 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.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

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

property arguments¶

Gets the arguments of this Run. 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 Run.
Return type: list[str]

property class_name¶

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

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

property compartment_id¶

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

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

property configuration¶

Gets the configuration of this Run. 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 Run.
Return type: dict(str, str)

property data_read_in_bytes¶

Gets the data_read_in_bytes of this Run. The data read by the run in bytes.

Returns: The data_read_in_bytes of this Run.
Return type: int

property data_written_in_bytes¶

Gets the data_written_in_bytes of this Run. The data written by the run in bytes.

Returns: The data_written_in_bytes of this Run.
Return type: int

property defined_tags¶

Gets the defined_tags of this Run. 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 Run.
Return type: dict(str, dict(str, object))

property display_name¶

Gets the display_name of this Run. A user-friendly name. This name is not necessarily unique.

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

property driver_shape¶

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

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

property driver_shape_config¶

Gets the driver_shape_config of this Run.

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

property execute¶

Gets the execute of this Run. 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 Run.
Return type: str

property executor_shape¶

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

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

property executor_shape_config¶

Gets the executor_shape_config of this Run.

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

property file_uri¶

[Required] Gets the file_uri of this Run. An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

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

property freeform_tags¶

Gets the freeform_tags of this Run. 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 Run.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this Run. The ID of a run.

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

property idle_timeout_in_minutes¶

Gets the idle_timeout_in_minutes of this Run. 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 Run.
Return type: int

property language¶

[Required] Gets the language of this Run. 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 Run.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this Run. The detailed messages about the lifecycle state.

Returns: The lifecycle_details of this Run.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this Run. The current state of this run.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “FAILED”, “SUCCEEDED”, “STOPPING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

property logs_bucket_uri¶

Gets the logs_bucket_uri of this Run. An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

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

property max_duration_in_minutes¶

Gets the max_duration_in_minutes of this Run. 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 Run.
Return type: int

property metastore_id¶

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

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

property num_executors¶

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

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

property opc_request_id¶

Gets the opc_request_id of this Run. Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns: The opc_request_id of this Run.
Return type: str

property owner_principal_id¶

Gets the owner_principal_id of this Run. The OCID of the user who created the resource.

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

property owner_user_name¶

Gets the owner_user_name of this Run. 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 Run.
Return type: str

property parameters¶

Gets the parameters of this Run. 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 Run.
Return type: list[oci.data_flow.models.ApplicationParameter]

property pool_id¶

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

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

property private_endpoint_dns_zones¶

Gets the private_endpoint_dns_zones of this Run. An array of DNS zone names. Example: [ “app.examplecorp.com”, “app.examplecorp2.com” ]

Returns: The private_endpoint_dns_zones of this Run.
Return type: list[str]

property private_endpoint_id¶

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

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

property private_endpoint_max_host_count¶

Gets the private_endpoint_max_host_count of this Run. The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.

Returns: The private_endpoint_max_host_count of this Run.
Return type: int

property private_endpoint_nsg_ids¶

Gets the private_endpoint_nsg_ids of this Run. An array of network security group OCIDs.

Returns: The private_endpoint_nsg_ids of this Run.
Return type: list[str]

property private_endpoint_subnet_id¶

Gets the private_endpoint_subnet_id of this Run. The OCID of a subnet.

Returns: The private_endpoint_subnet_id of this Run.
Return type: str

property run_duration_in_milliseconds¶

Gets the run_duration_in_milliseconds of this Run. The duration of the run in milliseconds.

Returns: The run_duration_in_milliseconds of this Run.
Return type: int

property spark_version¶

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

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

property time_created¶

[Required] Gets the time_created of this Run. 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 Run.
Return type: datetime

property time_updated¶

[Required] Gets the time_updated of this Run. 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 Run.
Return type: datetime

property total_o_cpu¶

Gets the total_o_cpu of this Run. The total number of oCPU requested by the run.

Returns: The total_o_cpu of this Run.
Return type: int

property type¶

Gets the type of this Run. 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 Run.
Return type: str

property warehouse_bucket_uri¶

Gets the warehouse_bucket_uri of this Run. An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.

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