@Generated(value="OracleSDKGenerator",
comments="API Version: 20200129")
public final class Run
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A run object.
Note: Objects should always be created or deserialized using the Run.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 Run.Builder, which maintain a
set of all explicitly set fields called Run.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 |
Run.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Run(String archiveUri,
List<String> arguments,
String applicationId,
ApplicationLogConfig applicationLogConfig,
String className,
String compartmentId,
Map<String,String> configuration,
Long dataReadInBytes,
Long dataWrittenInBytes,
Map<String,Map<String,Object>> definedTags,
String displayName,
String driverShape,
ShapeConfig driverShapeConfig,
String execute,
String executorShape,
ShapeConfig executorShapeConfig,
String fileUri,
Map<String,String> freeformTags,
String id,
ApplicationLanguage language,
String lifecycleDetails,
RunLifecycleState lifecycleState,
String logsBucketUri,
String metastoreId,
Integer numExecutors,
String opcRequestId,
String ownerPrincipalId,
String ownerUserName,
List<ApplicationParameter> parameters,
String poolId,
List<String> privateEndpointDnsZones,
Integer privateEndpointMaxHostCount,
List<String> privateEndpointNsgIds,
String privateEndpointId,
String privateEndpointSubnetId,
Long runDurationInMilliseconds,
String sparkVersion,
Date timeCreated,
Date timeUpdated,
Integer totalOCpu,
ApplicationType type,
String warehouseBucketUri,
Long maxDurationInMinutes,
Long idleTimeoutInMinutes)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Run.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getApplicationId()
The application ID.
|
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 |
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.
|
Long |
getDataReadInBytes()
The data read by the run in bytes.
|
Long |
getDataWrittenInBytes()
The data written by the run in bytes.
|
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.
|
ShapeConfig |
getDriverShapeConfig() |
String |
getExecute()
The input used for spark-submit command.
|
String |
getExecutorShape()
The VM shape for the executors.
|
ShapeConfig |
getExecutorShapeConfig() |
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 ID of a run.
|
Long |
getIdleTimeoutInMinutes()
The timeout value in minutes used to manage Runs.
|
ApplicationLanguage |
getLanguage()
The Spark language.
|
String |
getLifecycleDetails()
The detailed messages about the lifecycle state.
|
RunLifecycleState |
getLifecycleState()
The current state of this run.
|
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.
|
String |
getOpcRequestId()
Unique Oracle assigned identifier for the request.
|
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 |
getPoolId()
The OCID of a pool.
|
List<String> |
getPrivateEndpointDnsZones()
An array of DNS zone names.
|
String |
getPrivateEndpointId()
The OCID of a private endpoint.
|
Integer |
getPrivateEndpointMaxHostCount()
The maximum number of hosts to be accessed through the private endpoint.
|
List<String> |
getPrivateEndpointNsgIds()
An array of network security group OCIDs.
|
String |
getPrivateEndpointSubnetId()
The OCID of a subnet.
|
Long |
getRunDurationInMilliseconds()
The duration of the run in milliseconds.
|
String |
getSparkVersion()
The Spark version utilized to run the application.
|
Date |
getTimeCreated()
The date and time the resource was created, expressed in RFC
3339 timestamp format.
|
Date |
getTimeUpdated()
The date and time the resource was updated, expressed in RFC
3339 timestamp format.
|
Integer |
getTotalOCpu()
The total number of oCPU requested by the run.
|
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() |
Run.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"archiveUri","arguments","applicationId","applicationLogConfig","className","compartmentId","configuration","dataReadInBytes","dataWrittenInBytes","definedTags","displayName","driverShape","driverShapeConfig","execute","executorShape","executorShapeConfig","fileUri","freeformTags","id","language","lifecycleDetails","lifecycleState","logsBucketUri","metastoreId","numExecutors","opcRequestId","ownerPrincipalId","ownerUserName","parameters","poolId","privateEndpointDnsZones","privateEndpointMaxHostCount","privateEndpointNsgIds","privateEndpointId","privateEndpointSubnetId","runDurationInMilliseconds","sparkVersion","timeCreated","timeUpdated","totalOCpu","type","warehouseBucketUri","maxDurationInMinutes","idleTimeoutInMinutes"}) public Run(String archiveUri, List<String> arguments, String applicationId, ApplicationLogConfig applicationLogConfig, String className, String compartmentId, Map<String,String> configuration, Long dataReadInBytes, Long dataWrittenInBytes, Map<String,Map<String,Object>> definedTags, String displayName, String driverShape, ShapeConfig driverShapeConfig, String execute, String executorShape, ShapeConfig executorShapeConfig, String fileUri, Map<String,String> freeformTags, String id, ApplicationLanguage language, String lifecycleDetails, RunLifecycleState lifecycleState, String logsBucketUri, String metastoreId, Integer numExecutors, String opcRequestId, String ownerPrincipalId, String ownerUserName, List<ApplicationParameter> parameters, String poolId, List<String> privateEndpointDnsZones, Integer privateEndpointMaxHostCount, List<String> privateEndpointNsgIds, String privateEndpointId, String privateEndpointSubnetId, Long runDurationInMilliseconds, String sparkVersion, Date timeCreated, Date timeUpdated, Integer totalOCpu, ApplicationType type, String warehouseBucketUri, Long maxDurationInMinutes, Long idleTimeoutInMinutes)
public static Run.Builder builder()
Create a new builder.
public Run.Builder toBuilder()
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 getApplicationId()
The application ID.
public ApplicationLogConfig getApplicationLogConfig()
public String getClassName()
The class for the application.
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 Long getDataReadInBytes()
The data read by the run in bytes.
public Long getDataWrittenInBytes()
The data written by the run in bytes.
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. This name is not necessarily unique.
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 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 ID of a run.
public ApplicationLanguage getLanguage()
The Spark language.
public String getLifecycleDetails()
The detailed messages about the lifecycle state.
public RunLifecycleState getLifecycleState()
The current state of this run.
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 getOpcRequestId()
Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 getPoolId()
The OCID of a pool. Unique Id to indentify a dataflow pool resource.
public List<String> getPrivateEndpointDnsZones()
An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com"
]
public Integer getPrivateEndpointMaxHostCount()
The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
public List<String> getPrivateEndpointNsgIds()
An array of network security group OCIDs.
public String getPrivateEndpointId()
The OCID of a private endpoint.
public String getPrivateEndpointSubnetId()
The OCID of a subnet.
public Long getRunDurationInMilliseconds()
The duration of the run in milliseconds.
public String getSparkVersion()
The Spark version utilized to run the application.
public Date getTimeCreated()
The date and time the resource was created, expressed in RFC
3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
public Date getTimeUpdated()
The date and time the resource was updated, expressed in RFC
3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
public Integer getTotalOCpu()
The total number of oCPU requested by the run.
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.