Package com.oracle.bmc.dataflow.model

Class Run.Builder

  • Enclosing class:
    Run
    public static class Run.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • archiveUri

        public Run.Builder archiveUri​(String archiveUri)
        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.

        Parameters:
        archiveUri - the value to set
        Returns:
        this builder

      • arguments

        public Run.Builder arguments​(List<String> arguments)
        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”

        Parameters:
        arguments - the value to set
        Returns:
        this builder

      • applicationId

        public Run.Builder applicationId​(String applicationId)
        The application ID.
        Parameters:
        applicationId - the value to set
        Returns:
        this builder

      • className

        public Run.Builder className​(String className)
        The class for the application.
        Parameters:
        className - the value to set
        Returns:
        this builder

      • compartmentId

        public Run.Builder compartmentId​(String compartmentId)
        The OCID of a compartment.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • configuration

        public Run.Builder configuration​(Map<String,​String> configuration)
        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.

        Parameters:
        configuration - the value to set
        Returns:
        this builder

      • dataReadInBytes

        public Run.Builder dataReadInBytes​(Long dataReadInBytes)
        The data read by the run in bytes.
        Parameters:
        dataReadInBytes - the value to set
        Returns:
        this builder

      • dataWrittenInBytes

        public Run.Builder dataWrittenInBytes​(Long dataWrittenInBytes)
        The data written by the run in bytes.
        Parameters:
        dataWrittenInBytes - the value to set
        Returns:
        this builder

      • definedTags

        public Run.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • displayName

        public Run.Builder displayName​(String displayName)
        A user-friendly name.

        This name is not necessarily unique.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • driverShape

        public Run.Builder driverShape​(String driverShape)
        The VM shape for the driver.

        Sets the driver cores and memory.

        Parameters:
        driverShape - the value to set
        Returns:
        this builder

      • execute

        public Run.Builder execute​(String execute)
        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.

        Parameters:
        execute - the value to set
        Returns:
        this builder

      • executorShape

        public Run.Builder executorShape​(String executorShape)
        The VM shape for the executors.

        Sets the executor cores and memory.

        Parameters:
        executorShape - the value to set
        Returns:
        this builder

      • fileUri

        public Run.Builder fileUri​(String fileUri)
        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.

        Parameters:
        fileUri - the value to set
        Returns:
        this builder

      • freeformTags

        public Run.Builder freeformTags​(Map<String,​String> freeformTags)
        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”}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • id

        public Run.Builder id​(String id)
        The ID of a run.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • language

        public Run.Builder language​(ApplicationLanguage language)
        The Spark language.
        Parameters:
        language - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public Run.Builder lifecycleDetails​(String lifecycleDetails)
        The detailed messages about the lifecycle state.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • lifecycleState

        public Run.Builder lifecycleState​(RunLifecycleState lifecycleState)
        The current state of this run.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • logsBucketUri

        public Run.Builder logsBucketUri​(String logsBucketUri)
        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.

        Parameters:
        logsBucketUri - the value to set
        Returns:
        this builder

      • metastoreId

        public Run.Builder metastoreId​(String metastoreId)
        The OCID of OCI Hive Metastore.
        Parameters:
        metastoreId - the value to set
        Returns:
        this builder

      • numExecutors

        public Run.Builder numExecutors​(Integer numExecutors)
        The number of executor VMs requested.
        Parameters:
        numExecutors - the value to set
        Returns:
        this builder

      • opcRequestId

        public Run.Builder opcRequestId​(String opcRequestId)
        Unique Oracle assigned identifier for the request.

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

        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder

      • ownerPrincipalId

        public Run.Builder ownerPrincipalId​(String ownerPrincipalId)
        The OCID of the user who created the resource.
        Parameters:
        ownerPrincipalId - the value to set
        Returns:
        this builder

      • ownerUserName

        public Run.Builder ownerUserName​(String ownerUserName)
        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.

        Parameters:
        ownerUserName - the value to set
        Returns:
        this builder

      • parameters

        public Run.Builder parameters​(List<ApplicationParameter> parameters)
        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}”} ]

        Parameters:
        parameters - the value to set
        Returns:
        this builder

      • poolId

        public Run.Builder poolId​(String poolId)
        The OCID of a pool.

        Unique Id to indentify a dataflow pool resource.

        Parameters:
        poolId - the value to set
        Returns:
        this builder

      • privateEndpointDnsZones

        public Run.Builder privateEndpointDnsZones​(List<String> privateEndpointDnsZones)
        An array of DNS zone names.

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

        Parameters:
        privateEndpointDnsZones - the value to set
        Returns:
        this builder

      • privateEndpointMaxHostCount

        public Run.Builder privateEndpointMaxHostCount​(Integer privateEndpointMaxHostCount)
        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.

        Parameters:
        privateEndpointMaxHostCount - the value to set
        Returns:
        this builder

      • privateEndpointNsgIds

        public Run.Builder privateEndpointNsgIds​(List<String> privateEndpointNsgIds)
        An array of network security group OCIDs.
        Parameters:
        privateEndpointNsgIds - the value to set
        Returns:
        this builder

      • privateEndpointId

        public Run.Builder privateEndpointId​(String privateEndpointId)
        The OCID of a private endpoint.
        Parameters:
        privateEndpointId - the value to set
        Returns:
        this builder

      • privateEndpointSubnetId

        public Run.Builder privateEndpointSubnetId​(String privateEndpointSubnetId)
        The OCID of a subnet.
        Parameters:
        privateEndpointSubnetId - the value to set
        Returns:
        this builder

      • runDurationInMilliseconds

        public Run.Builder runDurationInMilliseconds​(Long runDurationInMilliseconds)
        The duration of the run in milliseconds.
        Parameters:
        runDurationInMilliseconds - the value to set
        Returns:
        this builder

      • sparkVersion

        public Run.Builder sparkVersion​(String sparkVersion)
        The Spark version utilized to run the application.
        Parameters:
        sparkVersion - the value to set
        Returns:
        this builder

      • timeCreated

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

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

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

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

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

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • totalOCpu

        public Run.Builder totalOCpu​(Integer totalOCpu)
        The total number of oCPU requested by the run.
        Parameters:
        totalOCpu - the value to set
        Returns:
        this builder

      • type

        public Run.Builder type​(ApplicationType type)
        The Spark application processing type.
        Parameters:
        type - the value to set
        Returns:
        this builder

      • warehouseBucketUri

        public Run.Builder warehouseBucketUri​(String warehouseBucketUri)
        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.

        Parameters:
        warehouseBucketUri - the value to set
        Returns:
        this builder

      • maxDurationInMinutes

        public Run.Builder maxDurationInMinutes​(Long maxDurationInMinutes)
        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.

        Parameters:
        maxDurationInMinutes - the value to set
        Returns:
        this builder

      • idleTimeoutInMinutes

        public Run.Builder idleTimeoutInMinutes​(Long idleTimeoutInMinutes)
        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)

        Parameters:
        idleTimeoutInMinutes - the value to set
        Returns:
        this builder

      • build

        public Run build()