CreateLabelingJobRequest (AWS Java SDK :: Services

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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`HumanTaskConfig`	`humanTaskConfig()` Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
`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()`
`String`	`toString()` Returns a string representation of this object.

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

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
  - 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". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-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". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-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.
    
    For 3D point cloud task types, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
    
    For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,..., label_n with your label categories.
    
    {
    
    "document-version": "2018-11-28"
    
    "labels": [
    
    {
    
    "label": "label_1"
    
    },
    
    {
    
    "label": "label_2"
    
    },
    
    ...
    
    {
    
    "label": "label_n"
    
    }
    
    ]
    
    }
    
    Returns:
    
    The S3 URL of the file that defines the categories used to label the data objects.
    
    For 3D point cloud task types, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
    
    For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,..., label_n with your label categories.
    
    {
    
    "document-version": "2018-11-28"
    
    "labels": [
    
    {
    
    "label": "label_1"
    
    },
    
    {
    
    "label": "label_2"
    
    },
    
    ...
    
    {
    
    "label": "label_n"
    
    }
    
    ]
    
    }
  - 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 labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
    
    Returns:
    
    Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateLabelingJobRequest.Builder,CreateLabelingJobRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static CreateLabelingJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLabelingJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields