CreateLabelingJobRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
    - - software.amazon.awssdk.services.sagemaker.model.CreateLabelingJobRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateLabelingJobRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateLabelingJobRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`HumanTaskConfig`	`humanTaskConfig()` Configures the information required for human workers to complete a labeling task.
`LabelingJobInputConfig`	`inputConfig()` Input data 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`	`labelAttributeName()` The attribute name to use for the label in the output manifest file.
`String`	`labelCategoryConfigS3Uri()` The S3 URL of the file that defines the categories used to label the data objects.
`LabelingJobAlgorithmsConfig`	`labelingJobAlgorithmsConfig()` Configures the information required to perform automated data labeling.
`String`	`labelingJobName()` The name of the labeling job.
`LabelingJobOutputConfig`	`outputConfig()` The location of the 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 Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateLabelingJobRequest.Builder>`	`serializableBuilderClass()`
`LabelingJobStoppingConditions`	`stoppingConditions()` A set of conditions for stopping the labeling job.
`List<Tag>`	`tags()` An array of key/value pairs.
`CreateLabelingJobRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - labelingJobName
```
public String labelingJobName()
```
    The name of the labeling job. This name is used to identify the job in a list of labeling jobs.
    
    Returns:
    
    The name of the labeling job. This name is used to identify the job in a list of labeling jobs.
  - labelAttributeName
```
public String labelAttributeName()
```
    The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata" or "-ref".
    
    Returns:
    
    The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata" or "-ref".
  - inputConfig
```
public LabelingJobInputConfig inputConfig()
```
    Input data 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 data 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 LabelingJobOutputConfig outputConfig()
```
    The location of the 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 output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
  - roleArn
```
public String roleArn()
```
    The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.
    
    Returns:
    
    The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.
  - labelCategoryConfigS3Uri
```
public String labelCategoryConfigS3Uri()
```
    The S3 URL of the file that defines the categories used to label the data objects.
    
    Returns:
    
    The S3 URL of the file that defines the categories used to label the data objects.
  - stoppingConditions
```
public LabelingJobStoppingConditions stoppingConditions()
```
    A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.
    
    Returns:
    
    A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.
  - labelingJobAlgorithmsConfig
```
public LabelingJobAlgorithmsConfig labelingJobAlgorithmsConfig()
```
    Configures the information required to perform automated data labeling.
    
    Returns:
    
    Configures the information required to perform automated data labeling.
  - humanTaskConfig
```
public HumanTaskConfig humanTaskConfig()
```
    Configures the information required for human workers to complete a labeling task.
    
    Returns:
    
    Configures the information required for human workers to complete a labeling task.
  - tags
```
public List<Tag> tags()
```
    An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
  - toBuilder
```
public CreateLabelingJobRequest.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<CreateLabelingJobRequest.Builder,CreateLabelingJobRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateLabelingJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLabelingJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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 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.

Class CreateLabelingJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

labelingJobName

labelAttributeName

inputConfig

outputConfig

roleArn

labelCategoryConfigS3Uri

stoppingConditions

labelingJobAlgorithmsConfig

humanTaskConfig

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields