com.amazonaws.services.sagemaker.model

Class CreateLabelingJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateLabelingJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateLabelingJobRequest
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
CreateLabelingJobRequest()

Method Summary

Modifier and Type	Method and Description
CreateLabelingJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
HumanTaskConfig	getHumanTaskConfig() Configures the information required for human workers to complete a labeling task.
LabelingJobInputConfig	getInputConfig() Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
String	getLabelAttributeName() The attribute name to use for the label in the output manifest file.
String	getLabelCategoryConfigS3Uri() The S3 URL of the file that defines the categories used to label the data objects.
LabelingJobAlgorithmsConfig	getLabelingJobAlgorithmsConfig() Configures the information required to perform automated data labeling.
String	getLabelingJobName() The name of the labeling job.
LabelingJobOutputConfig	getOutputConfig() The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
String	getRoleArn() The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
LabelingJobStoppingConditions	getStoppingConditions() A set of conditions for stopping the labeling job.
List<Tag>	getTags() An array of key/value pairs.
int	hashCode()
void	setHumanTaskConfig(HumanTaskConfig humanTaskConfig) Configures the information required for human workers to complete a labeling task.
void	setInputConfig(LabelingJobInputConfig inputConfig) Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
void	setLabelAttributeName(String labelAttributeName) The attribute name to use for the label in the output manifest file.
void	setLabelCategoryConfigS3Uri(String labelCategoryConfigS3Uri) The S3 URL of the file that defines the categories used to label the data objects.
void	setLabelingJobAlgorithmsConfig(LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig) Configures the information required to perform automated data labeling.
void	setLabelingJobName(String labelingJobName) The name of the labeling job.
void	setOutputConfig(LabelingJobOutputConfig outputConfig) The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
void	setRoleArn(String roleArn) The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
void	setStoppingConditions(LabelingJobStoppingConditions stoppingConditions) A set of conditions for stopping the labeling job.
void	setTags(Collection<Tag> tags) An array of key/value pairs.
String	toString() Returns a string representation of this object.
CreateLabelingJobRequest	withHumanTaskConfig(HumanTaskConfig humanTaskConfig) Configures the information required for human workers to complete a labeling task.
CreateLabelingJobRequest	withInputConfig(LabelingJobInputConfig inputConfig) Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.
CreateLabelingJobRequest	withLabelAttributeName(String labelAttributeName) The attribute name to use for the label in the output manifest file.
CreateLabelingJobRequest	withLabelCategoryConfigS3Uri(String labelCategoryConfigS3Uri) The S3 URL of the file that defines the categories used to label the data objects.
CreateLabelingJobRequest	withLabelingJobAlgorithmsConfig(LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig) Configures the information required to perform automated data labeling.
CreateLabelingJobRequest	withLabelingJobName(String labelingJobName) The name of the labeling job.
CreateLabelingJobRequest	withOutputConfig(LabelingJobOutputConfig outputConfig) The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
CreateLabelingJobRequest	withRoleArn(String roleArn) The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
CreateLabelingJobRequest	withStoppingConditions(LabelingJobStoppingConditions stoppingConditions) A set of conditions for stopping the labeling job.
CreateLabelingJobRequest	withTags(Collection<Tag> tags) An array of key/value pairs.
CreateLabelingJobRequest	withTags(Tag... tags) 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

CreateLabelingJobRequest

public CreateLabelingJobRequest()

Method Detail

setLabelingJobName

public void setLabelingJobName(String labelingJobName)

The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

Parameters:

labelingJobName - The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

getLabelingJobName

public String getLabelingJobName()

The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

Returns:

The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

withLabelingJobName

public CreateLabelingJobRequest withLabelingJobName(String labelingJobName)

The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

Parameters:

labelingJobName - The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

Returns:

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

setLabelAttributeName

public void setLabelAttributeName(String labelAttributeName)

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".

Parameters:

labelAttributeName - The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".

getLabelAttributeName

public String getLabelAttributeName()

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".

Returns:

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".

withLabelAttributeName

public CreateLabelingJobRequest withLabelAttributeName(String labelAttributeName)

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".

Parameters:

labelAttributeName - The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".

Returns:

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

setInputConfig

public void setInputConfig(LabelingJobInputConfig inputConfig)

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

Parameters:

inputConfig - Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

getInputConfig

public LabelingJobInputConfig getInputConfig()

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

Returns:

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

withInputConfig

public CreateLabelingJobRequest withInputConfig(LabelingJobInputConfig inputConfig)

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

Parameters:

inputConfig - Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

Returns:

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

setOutputConfig

public void setOutputConfig(LabelingJobOutputConfig outputConfig)

The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

Parameters:

outputConfig - The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

getOutputConfig

public LabelingJobOutputConfig getOutputConfig()

The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

Returns:

The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

withOutputConfig

public CreateLabelingJobRequest withOutputConfig(LabelingJobOutputConfig outputConfig)

The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

Parameters:

outputConfig - The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

Parameters:

roleArn - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

getRoleArn

public String getRoleArn()

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

Returns:

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

withRoleArn

public CreateLabelingJobRequest withRoleArn(String roleArn)

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

Parameters:

roleArn - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

Returns:

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

setLabelCategoryConfigS3Uri

public void setLabelCategoryConfigS3Uri(String labelCategoryConfigS3Uri)

The S3 URL of the file that defines the categories used to label the data objects.

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

Parameters:

labelCategoryConfigS3Uri - The S3 URL of the file that defines the categories used to label the data objects.

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

getLabelCategoryConfigS3Uri

public String getLabelCategoryConfigS3Uri()

The S3 URL of the file that defines the categories used to label the data objects.

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

Returns:

The S3 URL of the file that defines the categories used to label the data objects.

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

withLabelCategoryConfigS3Uri

public CreateLabelingJobRequest withLabelCategoryConfigS3Uri(String labelCategoryConfigS3Uri)

The S3 URL of the file that defines the categories used to label the data objects.

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

Parameters:

labelCategoryConfigS3Uri - The S3 URL of the file that defines the categories used to label the data objects.

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

Returns:

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

setStoppingConditions

public void setStoppingConditions(LabelingJobStoppingConditions stoppingConditions)

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Parameters:

stoppingConditions - A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

getStoppingConditions

public LabelingJobStoppingConditions getStoppingConditions()

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Returns:

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

withStoppingConditions

public CreateLabelingJobRequest withStoppingConditions(LabelingJobStoppingConditions stoppingConditions)

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Parameters:

stoppingConditions - A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

Returns:

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

setLabelingJobAlgorithmsConfig

public void setLabelingJobAlgorithmsConfig(LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig)

Configures the information required to perform automated data labeling.

Parameters:

labelingJobAlgorithmsConfig - Configures the information required to perform automated data labeling.

getLabelingJobAlgorithmsConfig

public LabelingJobAlgorithmsConfig getLabelingJobAlgorithmsConfig()

Configures the information required to perform automated data labeling.

Returns:

Configures the information required to perform automated data labeling.

withLabelingJobAlgorithmsConfig

public CreateLabelingJobRequest withLabelingJobAlgorithmsConfig(LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig)

Configures the information required to perform automated data labeling.

Parameters:

labelingJobAlgorithmsConfig - Configures the information required to perform automated data labeling.

Returns:

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

setHumanTaskConfig

public void setHumanTaskConfig(HumanTaskConfig humanTaskConfig)

Configures the information required for human workers to complete a labeling task.

Parameters:

humanTaskConfig - Configures the information required for human workers to complete a labeling task.

getHumanTaskConfig

public HumanTaskConfig getHumanTaskConfig()

Configures the information required for human workers to complete a labeling task.

Returns:

Configures the information required for human workers to complete a labeling task.

withHumanTaskConfig

public CreateLabelingJobRequest withHumanTaskConfig(HumanTaskConfig humanTaskConfig)

Configures the information required for human workers to complete a labeling task.

Parameters:

humanTaskConfig - Configures the information required for human workers to complete a labeling task.

Returns:

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

getTags

public List<Tag> getTags()

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

Returns:

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)

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 - 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 CreateLabelingJobRequest withTags(Tag... tags)

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 - 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 CreateLabelingJobRequest withTags(Collection<Tag> tags)

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 - 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.

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 CreateLabelingJobRequest 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()