@Generated(value="OracleSDKGenerator", comments="API Version: 20200129") public final class Application extends Object
A Data Flow application object.
Application.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 Application.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).| Modifier and Type | Class and Description |
|---|---|
static class |
Application.Builder |
| Constructor and Description |
|---|
Application(String archiveUri,
List<String> arguments,
String className,
Map<String,String> configuration,
String compartmentId,
Map<String,Map<String,Object>> definedTags,
String description,
String displayName,
String driverShape,
String execute,
String executorShape,
String fileUri,
Map<String,String> freeformTags,
String id,
ApplicationLanguage language,
ApplicationLifecycleState lifecycleState,
String logsBucketUri,
String metastoreId,
Integer numExecutors,
String ownerPrincipalId,
String ownerUserName,
List<ApplicationParameter> parameters,
String privateEndpointId,
String sparkVersion,
Date timeCreated,
Date timeUpdated,
ApplicationType type,
String warehouseBucketUri)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Application.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getArchiveUri()
An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application.
|
List<String> |
getArguments()
The arguments passed to the running application as command line arguments.
|
String |
getClassName()
The class for the application.
|
String |
getCompartmentId()
The OCID of a compartment.
|
Map<String,String> |
getConfiguration()
The Spark configuration passed to the running process.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
A user-friendly description.
|
String |
getDisplayName()
A user-friendly name.
|
String |
getDriverShape()
The VM shape for the driver.
|
String |
getExecute()
The input used for spark-submit command.
|
String |
getExecutorShape()
The VM shape for the executors.
|
String |
getFileUri()
An Oracle Cloud Infrastructure URI of the file containing the application to execute.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The application ID.
|
ApplicationLanguage |
getLanguage()
The Spark language.
|
ApplicationLifecycleState |
getLifecycleState()
The current state of this application.
|
String |
getLogsBucketUri()
An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
|
String |
getMetastoreId()
The OCID of OCI Hive Metastore.
|
Integer |
getNumExecutors()
The number of executor VMs requested.
|
String |
getOwnerPrincipalId()
The OCID of the user who created the resource.
|
String |
getOwnerUserName()
The username of the user who created the resource.
|
List<ApplicationParameter> |
getParameters()
An array of name/value pairs used to fill placeholders found in properties like
Application.arguments. |
String |
getPrivateEndpointId()
The OCID of a private endpoint.
|
String |
getSparkVersion()
The Spark version utilized to run the application.
|
Date |
getTimeCreated()
The date and time a application was created, expressed in RFC 3339 timestamp format.
|
Date |
getTimeUpdated()
The date and time a application was updated, expressed in RFC 3339 timestamp format.
|
ApplicationType |
getType()
The Spark application processing type.
|
String |
getWarehouseBucketUri()
An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory
for BATCH SQL runs.
|
int |
hashCode() |
Application.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"archiveUri","arguments","className","configuration","compartmentId","definedTags","description","displayName","driverShape","execute","executorShape","fileUri","freeformTags","id","language","lifecycleState","logsBucketUri","metastoreId","numExecutors","ownerPrincipalId","ownerUserName","parameters","privateEndpointId","sparkVersion","timeCreated","timeUpdated","type","warehouseBucketUri"}) @Deprecated public Application(String archiveUri, List<String> arguments, String className, Map<String,String> configuration, String compartmentId, Map<String,Map<String,Object>> definedTags, String description, String displayName, String driverShape, String execute, String executorShape, String fileUri, Map<String,String> freeformTags, String id, ApplicationLanguage language, ApplicationLifecycleState lifecycleState, String logsBucketUri, String metastoreId, Integer numExecutors, String ownerPrincipalId, String ownerUserName, List<ApplicationParameter> parameters, String privateEndpointId, String sparkVersion, Date timeCreated, Date timeUpdated, ApplicationType type, String warehouseBucketUri)
public static Application.Builder builder()
Create a new builder.
public Application.Builder toBuilder()
public String getArchiveUri()
An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
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"
public String getClassName()
The class for the application.
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.
public String getCompartmentId()
The OCID of a compartment.
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"}}
public String getDescription()
A user-friendly description.
public String getDisplayName()
A user-friendly name. This name is not necessarily unique.
public String getDriverShape()
The VM shape for the driver. Sets the driver cores and memory.
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.
public String getExecutorShape()
The VM shape for the executors. Sets the executor cores and memory.
public String getFileUri()
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.
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"}
public String getId()
The application ID.
public ApplicationLanguage getLanguage()
The Spark language.
public ApplicationLifecycleState getLifecycleState()
The current state of this application.
public String getLogsBucketUri()
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.
public String getMetastoreId()
The OCID of OCI Hive Metastore.
public Integer getNumExecutors()
The number of executor VMs requested.
public String getOwnerPrincipalId()
The OCID of the user who created the resource.
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.
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}”} ]
public String getPrivateEndpointId()
The OCID of a private endpoint.
public String getSparkVersion()
The Spark version utilized to run the application.
public Date getTimeCreated()
The date and time a application was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-03T21:10:29.600Z
public Date getTimeUpdated()
The date and time a application was updated, expressed in RFC 3339 timestamp format.
Example: 2018-04-03T21:10:29.600Z
public ApplicationType getType()
The Spark application processing type.
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.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
Copyright © 2016–2022. All rights reserved.