Package software.amazon.awssdk.services.sagemaker.model

Class HumanLoopConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.HumanLoopConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HumanLoopConfig.Builder,HumanLoopConfig>
@Generated("software.amazon.awssdk:codegen") public final class HumanLoopConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HumanLoopConfig.Builder,HumanLoopConfig>

Describes the work to be performed by human workers.

See Also:

  • Method Details

    • workteamArn

      public final String workteamArn()

      Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

      Returns:
      Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

    • humanTaskUiArn

      public final String humanTaskUiArn()

      The Amazon Resource Name (ARN) of the human task user interface.

      You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

      To learn how to create a custom HTML template, see Create Custom Worker Task Template.

      To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

      Returns:
      The Amazon Resource Name (ARN) of the human task user interface.

      You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

      To learn how to create a custom HTML template, see Create Custom Worker Task Template.

      To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

    • taskTitle

      public final String taskTitle()

      A title for the human worker task.

      Returns:
      A title for the human worker task.

    • taskDescription

      public final String taskDescription()

      A description for the human worker task.

      Returns:
      A description for the human worker task.

    • taskCount

      public final Integer taskCount()

      The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

      Returns:
      The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

    • taskAvailabilityLifetimeInSeconds

      public final Integer taskAvailabilityLifetimeInSeconds()

      The length of time that a task remains available for review by human workers.

      Returns:
      The length of time that a task remains available for review by human workers.

    • taskTimeLimitInSeconds

      public final Integer taskTimeLimitInSeconds()

      The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

      Returns:
      The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

    • hasTaskKeywords

      public final boolean hasTaskKeywords()
      For responses, this returns true if the service returned a value for the TaskKeywords 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.

    • taskKeywords

      public final List<String> taskKeywords()

      Keywords used to describe the task so that workers can discover the task.

      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 hasTaskKeywords() method.

      Returns:
      Keywords used to describe the task so that workers can discover the task.

    • publicWorkforceTaskPrice

      public final PublicWorkforceTaskPrice publicWorkforceTaskPrice()
      Returns the value of the PublicWorkforceTaskPrice property for this object.
      Returns:
      The value of the PublicWorkforceTaskPrice property for this object.

    • toBuilder

      public HumanLoopConfig.Builder 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<HumanLoopConfig.Builder,HumanLoopConfig>
      Returns:
      a builder for type T

    • builder

      public static HumanLoopConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HumanLoopConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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