Package com.oracle.bmc.dataflow.model

Class Run

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200129")
public final class Run
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A run object.
    Note: Objects should always be created or deserialized using the Run.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Run.Builder, which maintain a set of all explicitly set fields called Run.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Run.Builder builder()
        Create a new builder.

      • getArchiveUri

        public String getArchiveUri()
        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 value

      • getArguments

        public List<String> getArguments()
        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 value

      • getApplicationId

        public String getApplicationId()
        The application ID.
        Returns:
        the value

      • getClassName

        public String getClassName()
        The class for the application.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of a compartment.
        Returns:
        the value

      • getConfiguration

        public Map<String,​String> getConfiguration()
        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 value

      • getDataReadInBytes

        public Long getDataReadInBytes()
        The data read by the run in bytes.
        Returns:
        the value

      • getDataWrittenInBytes

        public Long getDataWrittenInBytes()
        The data written by the run in bytes.
        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        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 value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        This name is not necessarily unique.

        Returns:
        the value

      • getDriverShape

        public String getDriverShape()
        The VM shape for the driver.

        Sets the driver cores and memory.

        Returns:
        the value

      • getDriverShapeConfig

        public ShapeConfig getDriverShapeConfig()

      • getExecute

        public String getExecute()
        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 value

      • getExecutorShape

        public String getExecutorShape()
        The VM shape for the executors.

        Sets the executor cores and memory.

        Returns:
        the value

      • getExecutorShapeConfig

        public ShapeConfig getExecutorShapeConfig()

      • getFileUri

        public String getFileUri()
        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 value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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 value

      • getId

        public String getId()
        The ID of a run.
        Returns:
        the value

      • getLanguage

        public ApplicationLanguage getLanguage()
        The Spark language.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        The detailed messages about the lifecycle state.
        Returns:
        the value

      • getLifecycleState

        public RunLifecycleState getLifecycleState()
        The current state of this run.
        Returns:
        the value

      • getLogsBucketUri

        public String getLogsBucketUri()
        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 value

      • getMetastoreId

        public String getMetastoreId()
        The OCID of OCI Hive Metastore.
        Returns:
        the value

      • getNumExecutors

        public Integer getNumExecutors()
        The number of executor VMs requested.
        Returns:
        the value

      • getOpcRequestId

        public String getOpcRequestId()
        Unique Oracle assigned identifier for the request.

        If you need to contact Oracle about a particular request, please provide the request ID.

        Returns:
        the value

      • getOwnerPrincipalId

        public String getOwnerPrincipalId()
        The OCID of the user who created the resource.
        Returns:
        the value

      • getOwnerUserName

        public String getOwnerUserName()
        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 value

      • getParameters

        public List<ApplicationParameter> getParameters()
        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 value

      • getPoolId

        public String getPoolId()
        The OCID of a pool.

        Unique Id to indentify a dataflow pool resource.

        Returns:
        the value

      • getPrivateEndpointDnsZones

        public List<String> getPrivateEndpointDnsZones()
        An array of DNS zone names.

        Example: [ “app.examplecorp.com”, “app.examplecorp2.com” ]

        Returns:
        the value

      • getPrivateEndpointMaxHostCount

        public Integer getPrivateEndpointMaxHostCount()
        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 value

      • getPrivateEndpointNsgIds

        public List<String> getPrivateEndpointNsgIds()
        An array of network security group OCIDs.
        Returns:
        the value

      • getPrivateEndpointId

        public String getPrivateEndpointId()
        The OCID of a private endpoint.
        Returns:
        the value

      • getPrivateEndpointSubnetId

        public String getPrivateEndpointSubnetId()
        The OCID of a subnet.
        Returns:
        the value

      • getRunDurationInMilliseconds

        public Long getRunDurationInMilliseconds()
        The duration of the run in milliseconds.
        Returns:
        the value

      • getSparkVersion

        public String getSparkVersion()
        The Spark version utilized to run the application.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the resource was created, expressed in RFC 3339 timestamp format.

        Example: 2018-04-03T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the resource was updated, expressed in RFC 3339 timestamp format.

        Example: 2018-04-03T21:10:29.600Z

        Returns:
        the value

      • getTotalOCpu

        public Integer getTotalOCpu()
        The total number of oCPU requested by the run.
        Returns:
        the value

      • getType

        public ApplicationType getType()
        The Spark application processing type.
        Returns:
        the value

      • getWarehouseBucketUri

        public String getWarehouseBucketUri()
        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 value

      • getMaxDurationInMinutes

        public Long getMaxDurationInMinutes()
        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 value

      • getIdleTimeoutInMinutes

        public Long getIdleTimeoutInMinutes()
        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 value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel