Class DescribeLabelingJobResponse

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

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

    • 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:
    • 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:
    • 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 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

      public final String 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

      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()
      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 the 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.
    • tags

      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.

      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

      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

      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 interface ToCopyableBuilder<DescribeLabelingJobResponse.Builder,DescribeLabelingJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.