com.amazonaws.services.sagemaker.model

Class CreateProcessingJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateProcessingJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateProcessingJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateProcessingJobRequest()

Method Summary

Modifier and Type	Method and Description
CreateProcessingJobRequest	addEnvironmentEntry(String key, String value) Add a single Environment entry
CreateProcessingJobRequest	clearEnvironmentEntries() Removes all the entries added into Environment.
CreateProcessingJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AppSpecification	getAppSpecification() Configures the processing job to run a specified Docker container image.
Map<String,String>	getEnvironment() Sets the environment variables in the Docker container.
ExperimentConfig	getExperimentConfig()
NetworkConfig	getNetworkConfig() Networking options for a processing job.
List<ProcessingInput>	getProcessingInputs() For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.
String	getProcessingJobName() The name of the processing job.
ProcessingOutputConfig	getProcessingOutputConfig() Output configuration for the processing job.
ProcessingResources	getProcessingResources() Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
ProcessingStoppingCondition	getStoppingCondition() The time limit for how long the processing job is allowed to run.
List<Tag>	getTags() (Optional) An array of key-value pairs.
int	hashCode()
void	setAppSpecification(AppSpecification appSpecification) Configures the processing job to run a specified Docker container image.
void	setEnvironment(Map<String,String> environment) Sets the environment variables in the Docker container.
void	setExperimentConfig(ExperimentConfig experimentConfig)
void	setNetworkConfig(NetworkConfig networkConfig) Networking options for a processing job.
void	setProcessingInputs(Collection<ProcessingInput> processingInputs) For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.
void	setProcessingJobName(String processingJobName) The name of the processing job.
void	setProcessingOutputConfig(ProcessingOutputConfig processingOutputConfig) Output configuration for the processing job.
void	setProcessingResources(ProcessingResources processingResources) Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
void	setStoppingCondition(ProcessingStoppingCondition stoppingCondition) The time limit for how long the processing job is allowed to run.
void	setTags(Collection<Tag> tags) (Optional) An array of key-value pairs.
String	toString() Returns a string representation of this object.
CreateProcessingJobRequest	withAppSpecification(AppSpecification appSpecification) Configures the processing job to run a specified Docker container image.
CreateProcessingJobRequest	withEnvironment(Map<String,String> environment) Sets the environment variables in the Docker container.
CreateProcessingJobRequest	withExperimentConfig(ExperimentConfig experimentConfig)
CreateProcessingJobRequest	withNetworkConfig(NetworkConfig networkConfig) Networking options for a processing job.
CreateProcessingJobRequest	withProcessingInputs(Collection<ProcessingInput> processingInputs) For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.
CreateProcessingJobRequest	withProcessingInputs(ProcessingInput... processingInputs) For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.
CreateProcessingJobRequest	withProcessingJobName(String processingJobName) The name of the processing job.
CreateProcessingJobRequest	withProcessingOutputConfig(ProcessingOutputConfig processingOutputConfig) Output configuration for the processing job.
CreateProcessingJobRequest	withProcessingResources(ProcessingResources processingResources) Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.
CreateProcessingJobRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
CreateProcessingJobRequest	withStoppingCondition(ProcessingStoppingCondition stoppingCondition) The time limit for how long the processing job is allowed to run.
CreateProcessingJobRequest	withTags(Collection<Tag> tags) (Optional) An array of key-value pairs.
CreateProcessingJobRequest	withTags(Tag... tags) (Optional) An array of key-value pairs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateProcessingJobRequest

public CreateProcessingJobRequest()

Method Detail

getProcessingInputs

public List<ProcessingInput> getProcessingInputs()

For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

Returns:

For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

setProcessingInputs

public void setProcessingInputs(Collection<ProcessingInput> processingInputs)

For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

Parameters:

processingInputs - For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

withProcessingInputs

public CreateProcessingJobRequest withProcessingInputs(ProcessingInput... processingInputs)

For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

NOTE: This method appends the values to the existing list (if any). Use setProcessingInputs(java.util.Collection) or withProcessingInputs(java.util.Collection) if you want to override the existing values.

Parameters:

processingInputs - For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

Returns:

Returns a reference to this object so that method calls can be chained together.

withProcessingInputs

public CreateProcessingJobRequest withProcessingInputs(Collection<ProcessingInput> processingInputs)

For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

Parameters:

processingInputs - For each input, data is downloaded from S3 into the processing container before the processing job begins running if "S3InputMode" is set to File.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProcessingOutputConfig

public void setProcessingOutputConfig(ProcessingOutputConfig processingOutputConfig)

Output configuration for the processing job.

Parameters:

processingOutputConfig - Output configuration for the processing job.

getProcessingOutputConfig

public ProcessingOutputConfig getProcessingOutputConfig()

Output configuration for the processing job.

Returns:

Output configuration for the processing job.

withProcessingOutputConfig

public CreateProcessingJobRequest withProcessingOutputConfig(ProcessingOutputConfig processingOutputConfig)

Output configuration for the processing job.

Parameters:

processingOutputConfig - Output configuration for the processing job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProcessingJobName

public void setProcessingJobName(String processingJobName)

The name of the processing job. The name must be unique within an AWS Region in the AWS account.

Parameters:

processingJobName - The name of the processing job. The name must be unique within an AWS Region in the AWS account.

getProcessingJobName

public String getProcessingJobName()

The name of the processing job. The name must be unique within an AWS Region in the AWS account.

Returns:

The name of the processing job. The name must be unique within an AWS Region in the AWS account.

withProcessingJobName

public CreateProcessingJobRequest withProcessingJobName(String processingJobName)

The name of the processing job. The name must be unique within an AWS Region in the AWS account.

Parameters:

processingJobName - The name of the processing job. The name must be unique within an AWS Region in the AWS account.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProcessingResources

public void setProcessingResources(ProcessingResources processingResources)

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

Parameters:

processingResources - Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

getProcessingResources

public ProcessingResources getProcessingResources()

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

Returns:

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

withProcessingResources

public CreateProcessingJobRequest withProcessingResources(ProcessingResources processingResources)

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

Parameters:

processingResources - Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStoppingCondition

public void setStoppingCondition(ProcessingStoppingCondition stoppingCondition)

The time limit for how long the processing job is allowed to run.

Parameters:

stoppingCondition - The time limit for how long the processing job is allowed to run.

getStoppingCondition

public ProcessingStoppingCondition getStoppingCondition()

The time limit for how long the processing job is allowed to run.

Returns:

The time limit for how long the processing job is allowed to run.

withStoppingCondition

public CreateProcessingJobRequest withStoppingCondition(ProcessingStoppingCondition stoppingCondition)

The time limit for how long the processing job is allowed to run.

Parameters:

stoppingCondition - The time limit for how long the processing job is allowed to run.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAppSpecification

public void setAppSpecification(AppSpecification appSpecification)

Configures the processing job to run a specified Docker container image.

Parameters:

appSpecification - Configures the processing job to run a specified Docker container image.

getAppSpecification

public AppSpecification getAppSpecification()

Configures the processing job to run a specified Docker container image.

Returns:

Configures the processing job to run a specified Docker container image.

withAppSpecification

public CreateProcessingJobRequest withAppSpecification(AppSpecification appSpecification)

Configures the processing job to run a specified Docker container image.

Parameters:

appSpecification - Configures the processing job to run a specified Docker container image.

Returns:

Returns a reference to this object so that method calls can be chained together.

getEnvironment

public Map<String,String> getEnvironment()

Sets the environment variables in the Docker container.

Returns:

Sets the environment variables in the Docker container.

setEnvironment

public void setEnvironment(Map<String,String> environment)

Sets the environment variables in the Docker container.

Parameters:

environment - Sets the environment variables in the Docker container.

withEnvironment

public CreateProcessingJobRequest withEnvironment(Map<String,String> environment)

Sets the environment variables in the Docker container.

Parameters:

environment - Sets the environment variables in the Docker container.

Returns:

Returns a reference to this object so that method calls can be chained together.

addEnvironmentEntry

public CreateProcessingJobRequest addEnvironmentEntry(String key,
                                                      String value)

Add a single Environment entry

See Also:

withEnvironment(java.util.Map<java.lang.String, java.lang.String>)

clearEnvironmentEntries

public CreateProcessingJobRequest clearEnvironmentEntries()

Removes all the entries added into Environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNetworkConfig

public void setNetworkConfig(NetworkConfig networkConfig)

Networking options for a processing job.

Parameters:

networkConfig - Networking options for a processing job.

getNetworkConfig

public NetworkConfig getNetworkConfig()

Networking options for a processing job.

Returns:

Networking options for a processing job.

withNetworkConfig

public CreateProcessingJobRequest withNetworkConfig(NetworkConfig networkConfig)

Networking options for a processing job.

Parameters:

networkConfig - Networking options for a processing job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Returns:

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

withRoleArn

public CreateProcessingJobRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Returns:

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

setTags

public void setTags(Collection<Tag> tags)

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Parameters:

tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

withTags

public CreateProcessingJobRequest withTags(Tag... tags)

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateProcessingJobRequest withTags(Collection<Tag> tags)

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Parameters:

tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExperimentConfig

public void setExperimentConfig(ExperimentConfig experimentConfig)

Parameters:

experimentConfig -

getExperimentConfig

public ExperimentConfig getExperimentConfig()

Returns:

withExperimentConfig

public CreateProcessingJobRequest withExperimentConfig(ExperimentConfig experimentConfig)

Parameters:

experimentConfig -

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateProcessingJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()