@Generated(value="software.amazon.awssdk:codegen") public final class DescribeLabelingJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeLabelingJobResponse.Builder,DescribeLabelingJobResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeLabelingJobResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DescribeLabelingJobResponse.Builder |
builder() |
Instant |
creationTime()
The date and time that the labeling job was created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
failureReason()
If the job failed, the reason that it failed.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
HumanTaskConfig |
humanTaskConfig()
Configuration information required for human workers to complete a labeling task.
|
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.
|
String |
jobReferenceCode()
A unique identifier for work done as part of a labeling job.
|
String |
labelAttributeName()
The attribute used as the label in the output manifest file.
|
String |
labelCategoryConfigS3Uri()
The S3 location of the JSON file that defines the categories used to label data objects.
|
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 |
labelingJobAlgorithmsConfig()
Configuration information for automated data labeling.
|
String |
labelingJobArn()
The Amazon Resource Name (ARN) of the labeling job.
|
String |
labelingJobName()
The name assigned to the labeling job when it was created.
|
LabelingJobOutput |
labelingJobOutput()
The location of the output produced by the labeling job.
|
LabelingJobStatus |
labelingJobStatus()
The processing status of the labeling job.
|
String |
labelingJobStatusAsString()
The processing status of the labeling job.
|
Instant |
lastModifiedTime()
The date and time that the labeling job was last updated.
|
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.
|
String |
roleArn()
The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeLabelingJobResponse.Builder> |
serializableBuilderClass() |
LabelingJobStoppingConditions |
stoppingConditions()
A set of conditions for stopping a labeling job.
|
List<Tag> |
tags()
An array of key-value pairs.
|
DescribeLabelingJobResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final LabelingJobStatus labelingJobStatus()
The processing status of the labeling job.
If the service returns an enum value that is not available in the current SDK version, labelingJobStatus
will return LabelingJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from labelingJobStatusAsString().
LabelingJobStatuspublic final String labelingJobStatusAsString()
The processing status of the labeling job.
If the service returns an enum value that is not available in the current SDK version, labelingJobStatus
will return LabelingJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from labelingJobStatusAsString().
LabelingJobStatuspublic final 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.
public final String failureReason()
If the job failed, the reason that it failed.
public final Instant creationTime()
The date and time that the labeling job was created.
public final Instant lastModifiedTime()
The date and time that the labeling job was last updated.
public final String jobReferenceCode()
A unique identifier for work done as part of a labeling job.
public final String labelingJobName()
The name assigned to the labeling job when it was created.
public final String labelingJobArn()
The Amazon Resource Name (ARN) of the labeling job.
public final String labelAttributeName()
The attribute used as the label in the output manifest file.
public final 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.
public final 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.
public final String roleArn()
The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
public final String 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"
}
]
}
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"
}
]
}
public final LabelingJobStoppingConditions stoppingConditions()
A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
public final LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig()
Configuration information for automated data labeling.
public final HumanTaskConfig humanTaskConfig()
Configuration information required for human workers to complete a labeling task.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final LabelingJobOutput labelingJobOutput()
The location of the output produced by the labeling job.
public DescribeLabelingJobResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeLabelingJobResponse.Builder,DescribeLabelingJobResponse>toBuilder in class AwsResponsepublic static DescribeLabelingJobResponse.Builder builder()
public static Class<? extends DescribeLabelingJobResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2022. All rights reserved.