Class DescribeLabelingJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeLabelingJobResponse.Builder,
DescribeLabelingJobResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The date and time that the labeling job was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If the job failed, the reason that it failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final HumanTaskConfig
Configuration information required for human workers to complete a labeling task.final LabelingJobInputConfig
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.final String
A unique identifier for work done as part of a labeling job.final String
The attribute used as the label in the output manifest file.final String
The S3 location of the JSON file that defines the categories used to label data objects.final 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.Configuration information for automated data labeling.final String
The Amazon Resource Name (ARN) of the labeling job.final String
The name assigned to the labeling job when it was created.final LabelingJobOutput
The location of the output produced by the labeling job.final LabelingJobStatus
The processing status of the labeling job.final String
The processing status of the labeling job.final Instant
The date and time that the labeling job was last updated.final LabelingJobOutputConfig
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.final String
roleArn()
The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.static Class
<? extends DescribeLabelingJobResponse.Builder> A set of conditions for stopping a labeling job.tags()
An array of key-value pairs.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnLabelingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlabelingJobStatusAsString()
.- Returns:
- The processing status of the labeling job.
- See Also:
-
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 returnLabelingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlabelingJobStatusAsString()
.- Returns:
- The processing status of the labeling job.
- 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.
- Returns:
- 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.
-
failureReason
If the job failed, the reason that it failed.
- Returns:
- If the job failed, the reason that it failed.
-
creationTime
The date and time that the labeling job was created.
- Returns:
- The date and time that the labeling job was created.
-
lastModifiedTime
The date and time that the labeling job was last updated.
- Returns:
- The date and time that the labeling job was last updated.
-
jobReferenceCode
A unique identifier for work done as part of a labeling job.
- Returns:
- A unique identifier for work done as part of a labeling job.
-
labelingJobName
The name assigned to the labeling job when it was created.
- Returns:
- The name assigned to the labeling job when it was created.
-
labelingJobArn
The Amazon Resource Name (ARN) of the labeling job.
- Returns:
- The Amazon Resource Name (ARN) of the labeling job.
-
labelAttributeName
The attribute used as the label in the output manifest file.
- Returns:
- The attribute used as the label in the output manifest file.
-
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:
- 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.
-
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:
- 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.
-
roleArn
The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
- Returns:
- The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
-
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:
- 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"
}
]
}
-
-
-
stoppingConditions
A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
- Returns:
- A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
-
labelingJobAlgorithmsConfig
Configuration information for automated data labeling.
- Returns:
- Configuration information for automated data labeling.
-
humanTaskConfig
Configuration information required for human workers to complete a labeling task.
- Returns:
- Configuration information required for human workers to complete a labeling task.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- 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.
-
labelingJobOutput
The location of the output produced by the labeling job.
- Returns:
- The location of the output produced by the labeling job.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeLabelingJobResponse.Builder,
DescribeLabelingJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-