Interface DescribeLabelingJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeLabelingJobResponse.Builder,
,DescribeLabelingJobResponse> SageMakerResponse.Builder
,SdkBuilder<DescribeLabelingJobResponse.Builder,
,DescribeLabelingJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeLabelingJobResponse
-
Method Summary
Modifier and TypeMethodDescriptioncreationTime
(Instant creationTime) The date and time that the labeling job was created.failureReason
(String failureReason) If the job failed, the reason that it failed.humanTaskConfig
(Consumer<HumanTaskConfig.Builder> humanTaskConfig) Configuration information required for human workers to complete a labeling task.humanTaskConfig
(HumanTaskConfig humanTaskConfig) Configuration information required for human workers to complete a labeling task.inputConfig
(Consumer<LabelingJobInputConfig.Builder> inputConfig) Input configuration information 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.inputConfig
(LabelingJobInputConfig inputConfig) Input configuration information 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.jobReferenceCode
(String jobReferenceCode) A unique identifier for work done as part of a labeling job.labelAttributeName
(String labelAttributeName) The attribute used as the label in the output manifest file.labelCategoryConfigS3Uri
(String labelCategoryConfigS3Uri) The S3 location of the JSON file that defines the categories used to label data objects.labelCounters
(Consumer<LabelCounters.Builder> labelCounters) Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.labelCounters
(LabelCounters labelCounters) Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.labelingJobAlgorithmsConfig
(Consumer<LabelingJobAlgorithmsConfig.Builder> labelingJobAlgorithmsConfig) Configuration information for automated data labeling.labelingJobAlgorithmsConfig
(LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig) Configuration information for automated data labeling.labelingJobArn
(String labelingJobArn) The Amazon Resource Name (ARN) of the labeling job.labelingJobName
(String labelingJobName) The name assigned to the labeling job when it was created.labelingJobOutput
(Consumer<LabelingJobOutput.Builder> labelingJobOutput) The location of the output produced by the labeling job.labelingJobOutput
(LabelingJobOutput labelingJobOutput) The location of the output produced by the labeling job.labelingJobStatus
(String labelingJobStatus) The processing status of the labeling job.labelingJobStatus
(LabelingJobStatus labelingJobStatus) The processing status of the labeling job.lastModifiedTime
(Instant lastModifiedTime) The date and time that the labeling job was last updated.outputConfig
(Consumer<LabelingJobOutputConfig.Builder> outputConfig) The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.outputConfig
(LabelingJobOutputConfig outputConfig) The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.stoppingConditions
(Consumer<LabelingJobStoppingConditions.Builder> stoppingConditions) A set of conditions for stopping a labeling job.stoppingConditions
(LabelingJobStoppingConditions stoppingConditions) A set of conditions for stopping a labeling job.tags
(Collection<Tag> tags) An array of key-value pairs.tags
(Consumer<Tag.Builder>... tags) An array of key-value pairs.An array of key-value pairs.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
labelingJobStatus
The processing status of the labeling job.
- Parameters:
labelingJobStatus
- The processing status of the labeling job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
labelingJobStatus
The processing status of the labeling job.
- Parameters:
labelingJobStatus
- The processing status of the labeling job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
labelCounters
Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.
- Parameters:
labelCounters
- Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labelCounters
default DescribeLabelingJobResponse.Builder labelCounters(Consumer<LabelCounters.Builder> labelCounters) Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.
This is a convenience method that creates an instance of theLabelCounters.Builder
avoiding the need to create one manually viaLabelCounters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolabelCounters(LabelCounters)
.- Parameters:
labelCounters
- a consumer that will call methods onLabelCounters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
failureReason
If the job failed, the reason that it failed.
- Parameters:
failureReason
- If the job failed, the reason that it failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTime
The date and time that the labeling job was created.
- Parameters:
creationTime
- The date and time that the labeling job was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastModifiedTime
The date and time that the labeling job was last updated.
- Parameters:
lastModifiedTime
- The date and time that the labeling job was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobReferenceCode
A unique identifier for work done as part of a labeling job.
- Parameters:
jobReferenceCode
- A unique identifier for work done as part of a labeling job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labelingJobName
The name assigned to the labeling job when it was created.
- Parameters:
labelingJobName
- The name assigned to the labeling job when it was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labelingJobArn
The Amazon Resource Name (ARN) of the labeling job.
- Parameters:
labelingJobArn
- The Amazon Resource Name (ARN) of the labeling job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labelAttributeName
The attribute used as the label in the output manifest file.
- Parameters:
labelAttributeName
- The attribute used as the label in the output manifest file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputConfig
Input configuration information 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 configuration information 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.
-
inputConfig
default DescribeLabelingJobResponse.Builder inputConfig(Consumer<LabelingJobInputConfig.Builder> inputConfig) Input configuration information 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.
This is a convenience method that creates an instance of theLabelingJobInputConfig.Builder
avoiding the need to create one manually viaLabelingJobInputConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputConfig(LabelingJobInputConfig)
.- Parameters:
inputConfig
- a consumer that will call methods onLabelingJobInputConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputConfig
The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.
- Parameters:
outputConfig
- The location of the job's output data and the Amazon Web Services 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.
-
outputConfig
default DescribeLabelingJobResponse.Builder outputConfig(Consumer<LabelingJobOutputConfig.Builder> outputConfig) The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.
This is a convenience method that creates an instance of theLabelingJobOutputConfig.Builder
avoiding the need to create one manually viaLabelingJobOutputConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputConfig(LabelingJobOutputConfig)
.- Parameters:
outputConfig
- a consumer that will call methods onLabelingJobOutputConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
roleArn
The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labelCategoryConfigS3Uri
The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:
-
Semantic segmentation labeling jobs using automated labeling: 20 labels
-
Box bounding labeling jobs (all): 10 labels
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 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:-
Semantic segmentation labeling jobs using automated labeling: 20 labels
-
Box bounding labeling jobs (all): 10 labels
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.
-
-
stoppingConditions
DescribeLabelingJobResponse.Builder stoppingConditions(LabelingJobStoppingConditions stoppingConditions) A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
- Parameters:
stoppingConditions
- A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stoppingConditions
default DescribeLabelingJobResponse.Builder stoppingConditions(Consumer<LabelingJobStoppingConditions.Builder> stoppingConditions) A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
This is a convenience method that creates an instance of theLabelingJobStoppingConditions.Builder
avoiding the need to create one manually viaLabelingJobStoppingConditions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostoppingConditions(LabelingJobStoppingConditions)
.- Parameters:
stoppingConditions
- a consumer that will call methods onLabelingJobStoppingConditions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
labelingJobAlgorithmsConfig
DescribeLabelingJobResponse.Builder labelingJobAlgorithmsConfig(LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig) Configuration information for automated data labeling.
- Parameters:
labelingJobAlgorithmsConfig
- Configuration information for automated data labeling.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labelingJobAlgorithmsConfig
default DescribeLabelingJobResponse.Builder labelingJobAlgorithmsConfig(Consumer<LabelingJobAlgorithmsConfig.Builder> labelingJobAlgorithmsConfig) Configuration information for automated data labeling.
This is a convenience method that creates an instance of theLabelingJobAlgorithmsConfig.Builder
avoiding the need to create one manually viaLabelingJobAlgorithmsConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolabelingJobAlgorithmsConfig(LabelingJobAlgorithmsConfig)
.- Parameters:
labelingJobAlgorithmsConfig
- a consumer that will call methods onLabelingJobAlgorithmsConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
humanTaskConfig
Configuration information required for human workers to complete a labeling task.
- Parameters:
humanTaskConfig
- Configuration 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.
-
humanTaskConfig
default DescribeLabelingJobResponse.Builder humanTaskConfig(Consumer<HumanTaskConfig.Builder> humanTaskConfig) Configuration information required for human workers to complete a labeling task.
This is a convenience method that creates an instance of theHumanTaskConfig.Builder
avoiding the need to create one manually viaHumanTaskConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohumanTaskConfig(HumanTaskConfig)
.- Parameters:
humanTaskConfig
- a consumer that will call methods onHumanTaskConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
- Parameters:
tags
- An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
- Parameters:
tags
- An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
labelingJobOutput
The location of the output produced by the labeling job.
- Parameters:
labelingJobOutput
- The location of the output produced by the labeling job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labelingJobOutput
default DescribeLabelingJobResponse.Builder labelingJobOutput(Consumer<LabelingJobOutput.Builder> labelingJobOutput) The location of the output produced by the labeling job.
This is a convenience method that creates an instance of theLabelingJobOutput.Builder
avoiding the need to create one manually viaLabelingJobOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolabelingJobOutput(LabelingJobOutput)
.- Parameters:
labelingJobOutput
- a consumer that will call methods onLabelingJobOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-