Application.Builder (Oracle Cloud Infrastructure Java SDK

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

Enclosing class:: Application

public static class Application.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
`Application.Builder`	`applicationLogConfig(ApplicationLogConfig applicationLogConfig)`
`Application.Builder`	`archiveUri(String archiveUri)` A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs.
`Application.Builder`	`arguments(List<String> arguments)` The arguments passed to the running application as command line arguments.
`Application`	`build()`
`Application.Builder`	`className(String className)` The class for the application.
`Application.Builder`	`compartmentId(String compartmentId)` The OCID of a compartment.
`Application.Builder`	`configuration(Map<String,String> configuration)` The Spark configuration passed to the running process.
`Application.Builder`	`copy(Application model)`
`Application.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`Application.Builder`	`description(String description)` A user-friendly description.
`Application.Builder`	`displayName(String displayName)` A user-friendly name.
`Application.Builder`	`driverShape(String driverShape)` The VM shape for the driver.
`Application.Builder`	`driverShapeConfig(ShapeConfig driverShapeConfig)`
`Application.Builder`	`execute(String execute)` The input used for spark-submit command.
`Application.Builder`	`executorShape(String executorShape)` The VM shape for the executors.
`Application.Builder`	`executorShapeConfig(ShapeConfig executorShapeConfig)`
`Application.Builder`	`fileUri(String fileUri)` An Oracle Cloud Infrastructure URI of the file containing the application to execute.
`Application.Builder`	`freeformTags(Map<String,String> freeformTags)` Free-form tags for this resource.
`Application.Builder`	`id(String id)` The application ID.
`Application.Builder`	`idleTimeoutInMinutes(Long idleTimeoutInMinutes)` The timeout value in minutes used to manage Runs.
`Application.Builder`	`language(ApplicationLanguage language)` The Spark language.
`Application.Builder`	`lifecycleState(ApplicationLifecycleState lifecycleState)` The current state of this application.
`Application.Builder`	`logsBucketUri(String logsBucketUri)` An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
`Application.Builder`	`maxDurationInMinutes(Long maxDurationInMinutes)` The maximum duration in minutes for which an Application should run.
`Application.Builder`	`metastoreId(String metastoreId)` The OCID of OCI Hive Metastore.
`Application.Builder`	`numExecutors(Integer numExecutors)` The number of executor VMs requested.
`Application.Builder`	`ownerPrincipalId(String ownerPrincipalId)` The OCID of the user who created the resource.
`Application.Builder`	`ownerUserName(String ownerUserName)` The username of the user who created the resource.
`Application.Builder`	`parameters(List<ApplicationParameter> parameters)` An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`.
`Application.Builder`	`poolId(String poolId)` The OCID of a pool.
`Application.Builder`	`privateEndpointId(String privateEndpointId)` The OCID of a private endpoint.
`Application.Builder`	`sparkVersion(String sparkVersion)` The Spark version utilized to run the application.
`Application.Builder`	`timeCreated(Date timeCreated)` The date and time the resource was created, expressed in RFC 3339 timestamp format.
`Application.Builder`	`timeUpdated(Date timeUpdated)` The date and time the resource was updated, expressed in RFC 3339 timestamp format.
`Application.Builder`	`type(ApplicationType type)` The Spark application processing type.
`Application.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 Application.Builder applicationLogConfig(ApplicationLogConfig applicationLogConfig)
```
  - archiveUri
```
public Application.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 Application.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
  - className
```
public Application.Builder className(String className)
```
    The class for the application.
    
    Parameters:
    
    className - the value to set
    
    Returns:
    
    this builder
  - configuration
```
public Application.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
  - compartmentId
```
public Application.Builder compartmentId(String compartmentId)
```
    The OCID of a compartment.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - definedTags
```
public Application.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
  - description
```
public Application.Builder description(String description)
```
    A user-friendly description.
    
    Parameters:
    
    description - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public Application.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 Application.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 Application.Builder driverShapeConfig(ShapeConfig driverShapeConfig)
```
  - execute
```
public Application.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 Application.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 Application.Builder executorShapeConfig(ShapeConfig executorShapeConfig)
```
  - fileUri
```
public Application.Builder fileUri(String fileUri)
```
    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.
    
    Parameters:
    
    fileUri - the value to set
    
    Returns:
    
    this builder
  - freeformTags
```
public Application.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 Application.Builder id(String id)
```
    The application ID.
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - language
```
public Application.Builder language(ApplicationLanguage language)
```
    The Spark language.
    
    Parameters:
    
    language - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public Application.Builder lifecycleState(ApplicationLifecycleState lifecycleState)
```
    The current state of this application.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - logsBucketUri
```
public Application.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 Application.Builder metastoreId(String metastoreId)
```
    The OCID of OCI Hive Metastore.
    
    Parameters:
    
    metastoreId - the value to set
    
    Returns:
    
    this builder
  - numExecutors
```
public Application.Builder numExecutors(Integer numExecutors)
```
    The number of executor VMs requested.
    
    Parameters:
    
    numExecutors - the value to set
    
    Returns:
    
    this builder
  - ownerPrincipalId
```
public Application.Builder ownerPrincipalId(String ownerPrincipalId)
```
    The OCID of the user who created the resource.
    
    Parameters:
    
    ownerPrincipalId - the value to set
    
    Returns:
    
    this builder
  - ownerUserName
```
public Application.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 Application.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 Application.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
  - privateEndpointId
```
public Application.Builder privateEndpointId(String privateEndpointId)
```
    The OCID of a private endpoint.
    
    Parameters:
    
    privateEndpointId - the value to set
    
    Returns:
    
    this builder
  - sparkVersion
```
public Application.Builder sparkVersion(String sparkVersion)
```
    The Spark version utilized to run the application.
    
    Parameters:
    
    sparkVersion - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public Application.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 Application.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
  - type
```
public Application.Builder type(ApplicationType type)
```
    The Spark application processing type.
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    this builder
  - warehouseBucketUri
```
public Application.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 Application.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 Application.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 Application build()
```
  - copy
```
public Application.Builder copy(Application model)
```

Class Application.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

applicationLogConfig

archiveUri

arguments

className

configuration

compartmentId

definedTags

description

displayName

driverShape

driverShapeConfig

execute

executorShape

executorShapeConfig

fileUri

freeformTags

id

language

lifecycleState

logsBucketUri

metastoreId

numExecutors

ownerPrincipalId

ownerUserName

parameters

poolId

privateEndpointId

sparkVersion

timeCreated

timeUpdated

type

warehouseBucketUri

maxDurationInMinutes

idleTimeoutInMinutes

build

copy