@Generated(value="OracleSDKGenerator", comments="API Version: 20200129") public final class CreateRunDetails extends Object
The create run details. The following properties are optional and override the default values set in the associated application: - arguments - configuration - definedTags - driverShape - executorShape - freeformTags - logsBucketUri - numExecutors - parameters - warehouseBucketUri If the optional properties are not specified, they are copied over from the parent application. 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 __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 |
CreateRunDetails.Builder |
Constructor and Description |
---|
CreateRunDetails(String applicationId,
List<String> arguments,
String compartmentId,
Map<String,String> configuration,
Map<String,Map<String,Object>> definedTags,
String displayName,
String driverShape,
String executorShape,
Map<String,String> freeformTags,
String logsBucketUri,
Integer numExecutors,
List<ApplicationParameter> parameters,
String warehouseBucketUri)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static CreateRunDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getApplicationId()
The application ID.
|
List<String> |
getArguments()
The arguments passed to the running application as command line arguments.
|
String |
getCompartmentId()
The OCID of the compartment that contains this application.
|
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.
|
String |
getDriverShape()
The VM shape for the driver.
|
String |
getExecutorShape()
The VM shape for the executors.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getLogsBucketUri()
An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
|
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 |
getWarehouseBucketUri()
An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"applicationId","arguments","compartmentId","configuration","definedTags","displayName","driverShape","executorShape","freeformTags","logsBucketUri","numExecutors","parameters","warehouseBucketUri"}) @Deprecated public CreateRunDetails(String applicationId, List<String> arguments, String compartmentId, Map<String,String> configuration, Map<String,Map<String,Object>> definedTags, String displayName, String driverShape, String executorShape, Map<String,String> freeformTags, String logsBucketUri, Integer numExecutors, List<ApplicationParameter> parameters, String warehouseBucketUri)
public static CreateRunDetails.Builder builder()
Create a new builder.
public String getApplicationId()
The application ID.
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 the compartment that contains this 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 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. It does not have to be unique. Avoid entering confidential information.
public String getDriverShape()
The VM shape for the driver. Sets the driver cores and memory.
public String getExecutorShape()
The VM shape for the executors. Sets the executor cores and memory.
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 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 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–2020. All rights reserved.