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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
HumanLoopConfig.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HumanLoopConfig.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTaskKeywords()
For responses, this returns true if the service returned a value for the TaskKeywords property.String
humanTaskUiArn()
The Amazon Resource Name (ARN) of the human task user interface.PublicWorkforceTaskPrice
publicWorkforceTaskPrice()
Returns the value of the PublicWorkforceTaskPrice property for this object.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends HumanLoopConfig.Builder>
serializableBuilderClass()
Integer
taskAvailabilityLifetimeInSeconds()
The length of time that a task remains available for review by human workers.Integer
taskCount()
The number of distinct workers who will perform the same task on each object.String
taskDescription()
A description for the human worker task.List<String>
taskKeywords()
Keywords used to describe the task so that workers can discover the task.Integer
taskTimeLimitInSeconds()
The amount of time that a worker has to complete a task.String
taskTitle()
A title for the human worker task.HumanLoopConfig.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
workteamArn()
Amazon Resource Name (ARN) of a team of workers.-
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
-
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 to3
for an image classification labeling job, three workers will classify each input image. IncreasingTaskCount
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 to3
for an image classification labeling job, three workers will classify each input image. IncreasingTaskCount
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 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.
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<HumanLoopConfig.Builder,HumanLoopConfig>
-
builder
public static HumanLoopConfig.Builder builder()
-
serializableBuilderClass
public static Class<? extends HumanLoopConfig.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-