CreateLabelRequest (AWS Java SDK :: Services :: Lookout Equipment 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentRequest
    - - software.amazon.awssdk.services.lookoutequipment.model.CreateLabelRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateLabelRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateLabelRequest.Builder`	`builder()`
`String`	`clientToken()` A unique identifier for the request to create a label.
`Instant`	`endTime()` The end time of the labeled event.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`equipment()` Indicates that a label pertains to a particular piece of equipment.
`String`	`faultCode()` Provides additional information about the label.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`labelGroupName()` The name of a group of labels.
`String`	`notes()` Metadata providing additional information about the label.
`LabelRating`	`rating()` Indicates whether a labeled event represents an anomaly.
`String`	`ratingAsString()` Indicates whether a labeled event represents an anomaly.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateLabelRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The start time of the labeled event.
`CreateLabelRequest.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
  - labelGroupName
```
public final String labelGroupName()
```
    The name of a group of labels.
    
    Data in this field will be retained for service usage. Follow best practices for the security of your data.
    
    Returns:
    
    The name of a group of labels.
    
    Data in this field will be retained for service usage. Follow best practices for the security of your data.
  - startTime
```
public final Instant startTime()
```
    The start time of the labeled event.
    
    Returns:
    
    The start time of the labeled event.
  - endTime
```
public final Instant endTime()
```
    The end time of the labeled event.
    
    Returns:
    
    The end time of the labeled event.
  - rating
```
public final LabelRating rating()
```
    Indicates whether a labeled event represents an anomaly.
    
    If the service returns an enum value that is not available in the current SDK version, rating will return LabelRating.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ratingAsString().
    
    Returns:
    
    Indicates whether a labeled event represents an anomaly.
    
    See Also:
    
    LabelRating
  - ratingAsString
```
public final String ratingAsString()
```
    Indicates whether a labeled event represents an anomaly.
    
    If the service returns an enum value that is not available in the current SDK version, rating will return LabelRating.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ratingAsString().
    
    Returns:
    
    Indicates whether a labeled event represents an anomaly.
    
    See Also:
    
    LabelRating
  - faultCode
```
public final String faultCode()
```
    Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.
    
    Data in this field will be retained for service usage. Follow best practices for the security of your data.
    
    Returns:
    
    Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.
    
    Data in this field will be retained for service usage. Follow best practices for the security of your data.
  - notes
```
public final String notes()
```
    Metadata providing additional information about the label.
    
    Data in this field will be retained for service usage. Follow best practices for the security of your data.
    
    Returns:
    
    Metadata providing additional information about the label.
    
    Data in this field will be retained for service usage. Follow best practices for the security of your data.
  - equipment
```
public final String equipment()
```
    Indicates that a label pertains to a particular piece of equipment.
    
    Data in this field will be retained for service usage. Follow best practices for the security of your data.
    
    Returns:
    
    Indicates that a label pertains to a particular piece of equipment.
    
    Data in this field will be retained for service usage. Follow best practices for the security of your data.
  - clientToken
```
public final String clientToken()
```
    A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.
    
    Returns:
    
    A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.
  - toBuilder
```
public CreateLabelRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateLabelRequest.Builder,CreateLabelRequest>
    
    Specified by:
    
    toBuilder in class LookoutEquipmentRequest
  - builder
```
public static CreateLabelRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLabelRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateLabelRequest

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

labelGroupName

startTime

endTime

rating

ratingAsString

faultCode

notes

equipment

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields