Package software.amazon.awssdk.services.lookoutequipment.model

Class CreateLabelGroupRequest

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.CreateLabelGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLabelGroupRequest.Builder,CreateLabelGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateLabelGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateLabelGroupRequest.Builder	builder()
String	clientToken()	A unique identifier for the request to create a label group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	faultCodes()	The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFaultCodes()	For responses, this returns true if the service returned a value for the FaultCodes property.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	labelGroupName()	Names a group of labels.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLabelGroupRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Tags that provide metadata about the label group you are creating.
CreateLabelGroupRequest.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()

Names a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

Returns:

Names a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

hasFaultCodes

public final boolean hasFaultCodes()

For responses, this returns true if the service returned a value for the FaultCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

faultCodes

public final List<String> faultCodes()

The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

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 hasFaultCodes() method.

Returns:

The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.

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 group. 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 group. If you do not set the client request token, Lookout for Equipment generates one.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tags

public final List<Tag> tags()

Tags that provide metadata about the label group you are creating.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

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 hasTags() method.

Returns:

Tags that provide metadata about the label group you are creating.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

toBuilder

public CreateLabelGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLabelGroupRequest.Builder,CreateLabelGroupRequest>

Specified by:

toBuilder in class LookoutEquipmentRequest

builder

public static CreateLabelGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateLabelGroupRequest.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