@Stability(value=Experimental) @Internal public static final class BatchSubmitJobProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements BatchSubmitJobProps
BatchSubmitJobPropssoftware.amazon.jsii.JsiiObject.InitializationModeBatchSubmitJobProps.Builder, BatchSubmitJobProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(IJobDefinition jobDefinition,
String jobName,
IJobQueue jobQueue,
Number arraySize,
Number attempts,
BatchContainerOverrides containerOverrides,
List<? extends BatchJobDependency> dependsOn,
TaskInput payload,
String comment,
Duration heartbeat,
String inputPath,
IntegrationPattern integrationPattern,
String outputPath,
String resultPath,
Duration timeout)
Constructor that initializes the object based on literal property values passed by the
BatchSubmitJobProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Number |
getArraySize()
(experimental) The array size can be between 2 and 10,000.
|
Number |
getAttempts()
(experimental) The number of times to move a job to the RUNNABLE status.
|
String |
getComment()
(experimental) An optional description for this state.
|
BatchContainerOverrides |
getContainerOverrides()
(experimental) A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.
|
List<BatchJobDependency> |
getDependsOn()
(experimental) A list of dependencies for the job.
|
Duration |
getHeartbeat()
(experimental) Timeout for the heartbeat.
|
String |
getInputPath()
(experimental) JSONPath expression to select part of the state to be the input to this state.
|
IntegrationPattern |
getIntegrationPattern()
(experimental) AWS Step Functions integrates with services directly in the Amazon States Language.
|
IJobDefinition |
getJobDefinition()
(experimental) The job definition used by this job.
|
String |
getJobName()
(experimental) The name of the job.
|
IJobQueue |
getJobQueue()
(experimental) The job queue into which the job is submitted.
|
String |
getOutputPath()
(experimental) JSONPath expression to select select a portion of the state output to pass to the next state.
|
TaskInput |
getPayload()
(experimental) The payload to be passed as parameters to the batch job.
|
String |
getResultPath()
(experimental) JSONPath expression to indicate where to inject the state's output.
|
Duration |
getTimeout()
(experimental) Timeout for the state machine.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(IJobDefinition jobDefinition, String jobName, IJobQueue jobQueue, Number arraySize, Number attempts, BatchContainerOverrides containerOverrides, List<? extends BatchJobDependency> dependsOn, TaskInput payload, String comment, Duration heartbeat, String inputPath, IntegrationPattern integrationPattern, String outputPath, String resultPath, Duration timeout)
BatchSubmitJobProps.Builder.public final IJobDefinition getJobDefinition()
BatchSubmitJobPropsgetJobDefinition in interface BatchSubmitJobPropspublic final String getJobName()
BatchSubmitJobPropsThe first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
getJobName in interface BatchSubmitJobPropspublic final IJobQueue getJobQueue()
BatchSubmitJobPropsgetJobQueue in interface BatchSubmitJobPropspublic final Number getArraySize()
BatchSubmitJobPropsIf you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
Default: - No array size
getArraySize in interface BatchSubmitJobPropspublic final Number getAttempts()
BatchSubmitJobPropsYou may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
Default: 1
getAttempts in interface BatchSubmitJobPropspublic final BatchContainerOverrides getContainerOverrides()
BatchSubmitJobPropsDefault: - No container overrides
getContainerOverrides in interface BatchSubmitJobPropshttps://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverridespublic final List<BatchJobDependency> getDependsOn()
BatchSubmitJobPropsA job can depend upon a maximum of 20 jobs.
Default: - No dependencies
getDependsOn in interface BatchSubmitJobPropshttps://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOnpublic final TaskInput getPayload()
BatchSubmitJobPropsDefault: - No parameters are passed
getPayload in interface BatchSubmitJobPropspublic final String getComment()
TaskStateBasePropsDefault: - No comment
getComment in interface TaskStateBasePropspublic final Duration getHeartbeat()
TaskStateBasePropsDefault: - None
getHeartbeat in interface TaskStateBasePropspublic final String getInputPath()
TaskStateBasePropsMay also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
getInputPath in interface TaskStateBasePropspublic final IntegrationPattern getIntegrationPattern()
TaskStateBasePropsYou can control these AWS services using service integration patterns
Default: IntegrationPattern.REQUEST_RESPONSE
getIntegrationPattern in interface TaskStateBasePropshttps://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-tokenpublic final String getOutputPath()
TaskStateBasePropsMay also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
getOutputPath in interface TaskStateBasePropspublic final String getResultPath()
TaskStateBasePropsMay also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
getResultPath in interface TaskStateBasePropspublic final Duration getTimeout()
TaskStateBasePropsDefault: - None
getTimeout in interface TaskStateBaseProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2021. All rights reserved.