DescribeLabelingJobResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
    - - software.amazon.awssdk.services.sagemaker.model.DescribeLabelingJobResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeLabelingJobResponse.Builder,DescribeLabelingJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeLabelingJobResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeLabelingJobResponse.Builder,DescribeLabelingJobResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeLabelingJobResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeLabelingJobResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 AWS Key Management Service key ID for the key used to encrypt the output data, if any.
`String`	`roleArn()` The Amazon Resource Name (ARN) that Amazon 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.

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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - labelingJobStatus
```
public 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().
    
    Returns:
    
    The processing status of the labeling job.
    
    See Also:
    
    LabelingJobStatus
  - labelingJobStatusAsString
```
public 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().
    
    Returns:
    
    The processing status of the labeling job.
    
    See Also:
    
    LabelingJobStatus
  - labelCounters
```
public 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.
    
    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
```
public final String failureReason()
```
    If the job failed, the reason that it failed.
    
    Returns:
    
    If the job failed, the reason that it failed.
  - creationTime
```
public final Instant creationTime()
```
    The date and time that the labeling job was created.
    
    Returns:
    
    The date and time that the labeling job was created.
  - lastModifiedTime
```
public final Instant 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
```
public final String 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
```
public final String 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
```
public final String labelingJobArn()
```
    The Amazon Resource Name (ARN) of the labeling job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the labeling job.
  - labelAttributeName
```
public final String 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
```
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.
    
    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
```
public final LabelingJobOutputConfig outputConfig()
```
    The location of the job's 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 job's output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
    
    Returns:
    
    The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
  - labelCategoryConfigS3Uri
```
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"
    
    }
    
    ]
    
    }
    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
```
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.
    
    Returns:
    
    A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
  - labelingJobAlgorithmsConfig
```
public final LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig()
```
    Configuration information for automated data labeling.
    
    Returns:
    
    Configuration information for automated data labeling.
  - humanTaskConfig
```
public final HumanTaskConfig 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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
  - labelingJobOutput
```
public final LabelingJobOutput labelingJobOutput()
```
    The location of the output produced by the labeling job.
    
    Returns:
    
    The location of the output produced by the labeling job.
  - toBuilder
```
public DescribeLabelingJobResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeLabelingJobResponse.Builder,DescribeLabelingJobResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeLabelingJobResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeLabelingJobResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeLabelingJobResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

labelingJobStatus

labelingJobStatusAsString

labelCounters

failureReason

creationTime

lastModifiedTime

jobReferenceCode

labelingJobName

labelingJobArn

labelAttributeName

inputConfig

outputConfig

roleArn

labelCategoryConfigS3Uri

stoppingConditions

labelingJobAlgorithmsConfig

humanTaskConfig

hasTags

tags

labelingJobOutput

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields