@Generated(value="OracleSDKGenerator",
comments="API Version: 20200129")
public final class CreateRunDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The create run details. The following properties are optional and override the default values set in the associated application: - applicationId - archiveUri - applicationLogConfig - arguments - configuration - definedTags - displayName - driverShape - execute - executorShape - freeformTags
The optional parameter spark version can only be specified when using the execute parameter. If it is not specified when using the execute parameter, the latest version will be used as default. If the execute parameter is not used, the spark version will be taken from the associated application.
If displayName is not specified, it will be derived from the displayName of associated
application or set by API using fileUri's application file name. Once a run is created, its
properties (except for definedTags and freeformTags) cannot be changed. If the parent
application's properties (including definedTags and freeformTags) are updated, the corresponding
properties of the run will not update.
Note: Objects should always be created or deserialized using the CreateRunDetails.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 CreateRunDetails.Builder, which maintain a
set of all explicitly set fields called CreateRunDetails.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
CreateRunDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CreateRunDetails(ApplicationLogConfig applicationLogConfig,
String applicationId,
String archiveUri,
List<String> arguments,
String compartmentId,
Map<String,String> configuration,
Map<String,Map<String,Object>> definedTags,
String displayName,
String driverShape,
ShapeConfig driverShapeConfig,
String execute,
String executorShape,
ShapeConfig executorShapeConfig,
Map<String,String> freeformTags,
String logsBucketUri,
String metastoreId,
Integer numExecutors,
List<ApplicationParameter> parameters,
String poolId,
String sparkVersion,
ApplicationType type,
String warehouseBucketUri,
Long maxDurationInMinutes,
Long idleTimeoutInMinutes)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateRunDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getApplicationId()
The OCID of the associated application.
|
ApplicationLogConfig |
getApplicationLogConfig() |
String |
getArchiveUri()
A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs.
|
List<String> |
getArguments()
The arguments passed to the running application as command line arguments.
|
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 |
getDisplayName()
A user-friendly name that does not have to be unique.
|
String |
getDriverShape()
The VM shape for the driver.
|
ShapeConfig |
getDriverShapeConfig() |
String |
getExecute()
The input used for spark-submit command.
|
String |
getExecutorShape()
The VM shape for the executors.
|
ShapeConfig |
getExecutorShapeConfig() |
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
Long |
getIdleTimeoutInMinutes()
The timeout value in minutes used to manage Runs.
|
String |
getLogsBucketUri()
An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
|
Long |
getMaxDurationInMinutes()
The maximum duration in minutes for which an Application should run.
|
String |
getMetastoreId()
The OCID of OCI Hive Metastore.
|
Integer |
getNumExecutors()
The number of executor VMs requested.
|
List<ApplicationParameter> |
getParameters()
An array of name/value pairs used to fill placeholders found in properties like
Application.arguments. |
String |
getPoolId()
The OCID of a pool.
|
String |
getSparkVersion()
The Spark version utilized to run the application.
|
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() |
CreateRunDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"applicationLogConfig","applicationId","archiveUri","arguments","compartmentId","configuration","definedTags","displayName","driverShape","driverShapeConfig","execute","executorShape","executorShapeConfig","freeformTags","logsBucketUri","metastoreId","numExecutors","parameters","poolId","sparkVersion","type","warehouseBucketUri","maxDurationInMinutes","idleTimeoutInMinutes"}) public CreateRunDetails(ApplicationLogConfig applicationLogConfig, String applicationId, String archiveUri, List<String> arguments, String compartmentId, Map<String,String> configuration, Map<String,Map<String,Object>> definedTags, String displayName, String driverShape, ShapeConfig driverShapeConfig, String execute, String executorShape, ShapeConfig executorShapeConfig, Map<String,String> freeformTags, String logsBucketUri, String metastoreId, Integer numExecutors, List<ApplicationParameter> parameters, String poolId, String sparkVersion, ApplicationType type, String warehouseBucketUri, Long maxDurationInMinutes, Long idleTimeoutInMinutes)
public static CreateRunDetails.Builder builder()
Create a new builder.
public CreateRunDetails.Builder toBuilder()
public ApplicationLogConfig getApplicationLogConfig()
public String getApplicationId()
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.
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.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 getCompartmentId()
The OCID of a compartment.
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 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 getDisplayName()
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.
public String getDriverShape()
The VM shape for the driver. Sets the driver cores and memory.
public ShapeConfig getDriverShapeConfig()
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 ShapeConfig getExecutorShapeConfig()
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 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 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 getPoolId()
The OCID of a pool. Unique Id to indentify a dataflow pool resource.
public String getSparkVersion()
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.
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.
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.
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)
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.