HumanLoopConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class HumanLoopConfig

java.lang.Object
- com.amazonaws.services.sagemaker.model.HumanLoopConfig

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HumanLoopConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the work to be performed by human workers.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HumanLoopConfig ()

Constructors
Constructor and Description
`HumanLoopConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`HumanLoopConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getHumanTaskUiArn ()` The Amazon Resource Name (ARN) of the human task user interface.
`PublicWorkforceTaskPrice`	`getPublicWorkforceTaskPrice ()`
`Integer`	`getTaskAvailabilityLifetimeInSeconds ()` The length of time that a task remains available for review by human workers.
`Integer`	`getTaskCount ()` The number of distinct workers who will perform the same task on each object.
`String`	`getTaskDescription ()` A description for the human worker task.
`List<String>`	`getTaskKeywords ()` Keywords used to describe the task so that workers can discover the task.
`Integer`	`getTaskTimeLimitInSeconds ()` The amount of time that a worker has to complete a task.
`String`	`getTaskTitle ()` A title for the human worker task.
`String`	`getWorkteamArn ()` Amazon Resource Name (ARN) of a team of workers.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHumanTaskUiArn (String humanTaskUiArn)` The Amazon Resource Name (ARN) of the human task user interface.
`void`	`setPublicWorkforceTaskPrice (PublicWorkforceTaskPrice publicWorkforceTaskPrice)`
`void`	`setTaskAvailabilityLifetimeInSeconds (Integer taskAvailabilityLifetimeInSeconds)` The length of time that a task remains available for review by human workers.
`void`	`setTaskCount (Integer taskCount)` The number of distinct workers who will perform the same task on each object.
`void`	`setTaskDescription (String taskDescription)` A description for the human worker task.
`void`	`setTaskKeywords (Collection<String> taskKeywords)` Keywords used to describe the task so that workers can discover the task.
`void`	`setTaskTimeLimitInSeconds (Integer taskTimeLimitInSeconds)` The amount of time that a worker has to complete a task.
`void`	`setTaskTitle (String taskTitle)` A title for the human worker task.
`void`	`setWorkteamArn (String workteamArn)` Amazon Resource Name (ARN) of a team of workers.
`String`	`toString ()` Returns a string representation of this object.
`HumanLoopConfig`	`withHumanTaskUiArn (String humanTaskUiArn)` The Amazon Resource Name (ARN) of the human task user interface.
`HumanLoopConfig`	`withPublicWorkforceTaskPrice (PublicWorkforceTaskPrice publicWorkforceTaskPrice)`
`HumanLoopConfig`	`withTaskAvailabilityLifetimeInSeconds (Integer taskAvailabilityLifetimeInSeconds)` The length of time that a task remains available for review by human workers.
`HumanLoopConfig`	`withTaskCount (Integer taskCount)` The number of distinct workers who will perform the same task on each object.
`HumanLoopConfig`	`withTaskDescription (String taskDescription)` A description for the human worker task.
`HumanLoopConfig`	`withTaskKeywords (Collection<String> taskKeywords)` Keywords used to describe the task so that workers can discover the task.
`HumanLoopConfig`	`withTaskKeywords (String... taskKeywords)` Keywords used to describe the task so that workers can discover the task.
`HumanLoopConfig`	`withTaskTimeLimitInSeconds (Integer taskTimeLimitInSeconds)` The amount of time that a worker has to complete a task.
`HumanLoopConfig`	`withTaskTitle (String taskTitle)` A title for the human worker task.
`HumanLoopConfig`	`withWorkteamArn (String workteamArn)` Amazon Resource Name (ARN) of a team of workers.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HumanLoopConfig
```
public HumanLoopConfig()
```
- Method Detail
  - setWorkteamArn
```
public void setWorkteamArn(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.
    
    Parameters:
    
    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.
  - getWorkteamArn
```
public String getWorkteamArn()
```
    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.
  - withWorkteamArn
```
public HumanLoopConfig withWorkteamArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHumanTaskUiArn
```
public void setHumanTaskUiArn(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.
    
    Parameters:
    
    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.
  - getHumanTaskUiArn
```
public String getHumanTaskUiArn()
```
    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.
  - withHumanTaskUiArn
```
public HumanLoopConfig withHumanTaskUiArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskTitle
```
public void setTaskTitle(String taskTitle)
```
    A title for the human worker task.
    
    Parameters:
    
    taskTitle - A title for the human worker task.
  - getTaskTitle
```
public String getTaskTitle()
```
    A title for the human worker task.
    
    Returns:
    
    A title for the human worker task.
  - withTaskTitle
```
public HumanLoopConfig withTaskTitle(String taskTitle)
```
    A title for the human worker task.
    
    Parameters:
    
    taskTitle - A title for the human worker task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskDescription
```
public void setTaskDescription(String taskDescription)
```
    A description for the human worker task.
    
    Parameters:
    
    taskDescription - A description for the human worker task.
  - getTaskDescription
```
public String getTaskDescription()
```
    A description for the human worker task.
    
    Returns:
    
    A description for the human worker task.
  - withTaskDescription
```
public HumanLoopConfig withTaskDescription(String taskDescription)
```
    A description for the human worker task.
    
    Parameters:
    
    taskDescription - A description for the human worker task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskCount
```
public void setTaskCount(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.
    
    Parameters:
    
    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.
  - getTaskCount
```
public Integer getTaskCount()
```
    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.
  - withTaskCount
```
public HumanLoopConfig withTaskCount(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskAvailabilityLifetimeInSeconds
```
public void setTaskAvailabilityLifetimeInSeconds(Integer taskAvailabilityLifetimeInSeconds)
```
    The length of time that a task remains available for review by human workers.
    
    Parameters:
    
    taskAvailabilityLifetimeInSeconds - The length of time that a task remains available for review by human workers.
  - getTaskAvailabilityLifetimeInSeconds
```
public Integer getTaskAvailabilityLifetimeInSeconds()
```
    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.
  - withTaskAvailabilityLifetimeInSeconds
```
public HumanLoopConfig withTaskAvailabilityLifetimeInSeconds(Integer taskAvailabilityLifetimeInSeconds)
```
    The length of time that a task remains available for review by human workers.
    
    Parameters:
    
    taskAvailabilityLifetimeInSeconds - The length of time that a task remains available for review by human workers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskTimeLimitInSeconds
```
public void setTaskTimeLimitInSeconds(Integer taskTimeLimitInSeconds)
```
    The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
    
    Parameters:
    
    taskTimeLimitInSeconds - The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
  - getTaskTimeLimitInSeconds
```
public Integer getTaskTimeLimitInSeconds()
```
    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).
  - withTaskTimeLimitInSeconds
```
public HumanLoopConfig withTaskTimeLimitInSeconds(Integer taskTimeLimitInSeconds)
```
    The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
    
    Parameters:
    
    taskTimeLimitInSeconds - The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTaskKeywords
```
public List<String> getTaskKeywords()
```
    Keywords used to describe the task so that workers can discover the task.
    
    Returns:
    
    Keywords used to describe the task so that workers can discover the task.
  - setTaskKeywords
```
public void setTaskKeywords(Collection<String> taskKeywords)
```
    Keywords used to describe the task so that workers can discover the task.
    
    Parameters:
    
    taskKeywords - Keywords used to describe the task so that workers can discover the task.
  - withTaskKeywords
```
public HumanLoopConfig withTaskKeywords(String... taskKeywords)
```
    Keywords used to describe the task so that workers can discover the task.
    
    NOTE: This method appends the values to the existing list (if any). Use setTaskKeywords(java.util.Collection) or withTaskKeywords(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    taskKeywords - Keywords used to describe the task so that workers can discover the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTaskKeywords
```
public HumanLoopConfig withTaskKeywords(Collection<String> taskKeywords)
```
    Keywords used to describe the task so that workers can discover the task.
    
    Parameters:
    
    taskKeywords - Keywords used to describe the task so that workers can discover the task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublicWorkforceTaskPrice
```
public void setPublicWorkforceTaskPrice(PublicWorkforceTaskPrice publicWorkforceTaskPrice)
```
    Parameters:
    
    publicWorkforceTaskPrice -
  - getPublicWorkforceTaskPrice
```
public PublicWorkforceTaskPrice getPublicWorkforceTaskPrice()
```
    Returns:
  - withPublicWorkforceTaskPrice
```
public HumanLoopConfig withPublicWorkforceTaskPrice(PublicWorkforceTaskPrice publicWorkforceTaskPrice)
```
    Parameters:
    
    publicWorkforceTaskPrice -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HumanLoopConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class HumanLoopConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HumanLoopConfig

Method Detail

setWorkteamArn

getWorkteamArn

withWorkteamArn

setHumanTaskUiArn

getHumanTaskUiArn

withHumanTaskUiArn

setTaskTitle

getTaskTitle

withTaskTitle

setTaskDescription

getTaskDescription

withTaskDescription

setTaskCount

getTaskCount

withTaskCount

setTaskAvailabilityLifetimeInSeconds

getTaskAvailabilityLifetimeInSeconds

withTaskAvailabilityLifetimeInSeconds

setTaskTimeLimitInSeconds

getTaskTimeLimitInSeconds

withTaskTimeLimitInSeconds

getTaskKeywords

setTaskKeywords

withTaskKeywords

withTaskKeywords

setPublicWorkforceTaskPrice

getPublicWorkforceTaskPrice

withPublicWorkforceTaskPrice

toString

equals

hashCode

clone

marshall