CreateRunDetails.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.dataflow.model.CreateRunDetails.Builder

Enclosing class:: CreateRunDetails

public static class CreateRunDetails.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateRunDetails.Builder`	`applicationId(String applicationId)` The OCID of the associated application.
`CreateRunDetails.Builder`	`applicationLogConfig(ApplicationLogConfig applicationLogConfig)`
`CreateRunDetails.Builder`	`archiveUri(String archiveUri)` A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs.
`CreateRunDetails.Builder`	`arguments(List<String> arguments)` The arguments passed to the running application as command line arguments.
`CreateRunDetails`	`build()`
`CreateRunDetails.Builder`	`compartmentId(String compartmentId)` The OCID of a compartment.
`CreateRunDetails.Builder`	`configuration(Map<String,String> configuration)` The Spark configuration passed to the running process.
`CreateRunDetails.Builder`	`copy(CreateRunDetails model)`
`CreateRunDetails.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`CreateRunDetails.Builder`	`displayName(String displayName)` A user-friendly name that does not have to be unique.
`CreateRunDetails.Builder`	`driverShape(String driverShape)` The VM shape for the driver.
`CreateRunDetails.Builder`	`driverShapeConfig(ShapeConfig driverShapeConfig)`
`CreateRunDetails.Builder`	`execute(String execute)` The input used for spark-submit command.
`CreateRunDetails.Builder`	`executorShape(String executorShape)` The VM shape for the executors.
`CreateRunDetails.Builder`	`executorShapeConfig(ShapeConfig executorShapeConfig)`
`CreateRunDetails.Builder`	`freeformTags(Map<String,String> freeformTags)` Free-form tags for this resource.
`CreateRunDetails.Builder`	`idleTimeoutInMinutes(Long idleTimeoutInMinutes)` The timeout value in minutes used to manage Runs.
`CreateRunDetails.Builder`	`logsBucketUri(String logsBucketUri)` An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
`CreateRunDetails.Builder`	`maxDurationInMinutes(Long maxDurationInMinutes)` The maximum duration in minutes for which an Application should run.
`CreateRunDetails.Builder`	`metastoreId(String metastoreId)` The OCID of OCI Hive Metastore.
`CreateRunDetails.Builder`	`numExecutors(Integer numExecutors)` The number of executor VMs requested.
`CreateRunDetails.Builder`	`parameters(List<ApplicationParameter> parameters)` An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`.
`CreateRunDetails.Builder`	`poolId(String poolId)` The OCID of a pool.
`CreateRunDetails.Builder`	`sparkVersion(String sparkVersion)` The Spark version utilized to run the application.
`CreateRunDetails.Builder`	`type(ApplicationType type)` The Spark application processing type.
`CreateRunDetails.Builder`	`warehouseBucketUri(String warehouseBucketUri)` An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - applicationLogConfig
```
public CreateRunDetails.Builder applicationLogConfig(ApplicationLogConfig applicationLogConfig)
```
  - applicationId
```
public CreateRunDetails.Builder applicationId(String applicationId)
```
    The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
    
    Parameters:
    
    applicationId - the value to set
    
    Returns:
    
    this builder
  - archiveUri
```
public CreateRunDetails.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.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    
    Parameters:
    
    archiveUri - the value to set
    
    Returns:
    
    this builder
  - arguments
```
public CreateRunDetails.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
  - compartmentId
```
public CreateRunDetails.Builder compartmentId(String compartmentId)
```
    The OCID of a compartment.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - configuration
```
public CreateRunDetails.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
  - definedTags
```
public CreateRunDetails.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 CreateRunDetails.Builder displayName(String displayName)
```
    A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application’s displayName or set by API using fileUri’s application file name.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder
  - driverShape
```
public CreateRunDetails.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
  - driverShapeConfig
```
public CreateRunDetails.Builder driverShapeConfig(ShapeConfig driverShapeConfig)
```
  - execute
```
public CreateRunDetails.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 CreateRunDetails.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
  - executorShapeConfig
```
public CreateRunDetails.Builder executorShapeConfig(ShapeConfig executorShapeConfig)
```
  - freeformTags
```
public CreateRunDetails.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
  - logsBucketUri
```
public CreateRunDetails.Builder logsBucketUri(String logsBucketUri)
```
    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.
    
    Parameters:
    
    logsBucketUri - the value to set
    
    Returns:
    
    this builder
  - metastoreId
```
public CreateRunDetails.Builder metastoreId(String metastoreId)
```
    The OCID of OCI Hive Metastore.
    
    Parameters:
    
    metastoreId - the value to set
    
    Returns:
    
    this builder
  - numExecutors
```
public CreateRunDetails.Builder numExecutors(Integer numExecutors)
```
    The number of executor VMs requested.
    
    Parameters:
    
    numExecutors - the value to set
    
    Returns:
    
    this builder
  - parameters
```
public CreateRunDetails.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 CreateRunDetails.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
  - sparkVersion
```
public CreateRunDetails.Builder sparkVersion(String sparkVersion)
```
    The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
    
    Parameters:
    
    sparkVersion - the value to set
    
    Returns:
    
    this builder
  - type
```
public CreateRunDetails.Builder type(ApplicationType type)
```
    The Spark application processing type.
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    this builder
  - warehouseBucketUri
```
public CreateRunDetails.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.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    
    Parameters:
    
    warehouseBucketUri - the value to set
    
    Returns:
    
    this builder
  - maxDurationInMinutes
```
public CreateRunDetails.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 CreateRunDetails.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 CreateRunDetails build()
```
  - copy
```
public CreateRunDetails.Builder copy(CreateRunDetails model)
```

Class CreateRunDetails.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

applicationLogConfig

applicationId

archiveUri

arguments

compartmentId

configuration

definedTags

displayName

driverShape

driverShapeConfig

execute

executorShape

executorShapeConfig

freeformTags

logsBucketUri

metastoreId

numExecutors

parameters

poolId

sparkVersion

type

warehouseBucketUri

maxDurationInMinutes

idleTimeoutInMinutes

build

copy