Package software.amazon.awssdk.services.m2.model

Class AlternateKey

java.lang.Object

software.amazon.awssdk.services.m2.model.AlternateKey

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AlternateKey.Builder,AlternateKey>

@Generated("software.amazon.awssdk:codegen")
public final class AlternateKey
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AlternateKey.Builder,AlternateKey>

Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AlternateKey.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allowDuplicates()	Indicates whether the alternate key values are supposed to be unique for the given data set.
static AlternateKey.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	length()	A strictly positive integer value representing the length of the alternate key.
String	name()	The name of the alternate key.
Integer	offset()	A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.
List<SdkField<?>>	sdkFields()
static Class<? extends AlternateKey.Builder>	serializableBuilderClass()
AlternateKey.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

allowDuplicates

public final Boolean allowDuplicates()

Indicates whether the alternate key values are supposed to be unique for the given data set.

Returns:

Indicates whether the alternate key values are supposed to be unique for the given data set.

length

public final Integer length()

A strictly positive integer value representing the length of the alternate key.

Returns:

A strictly positive integer value representing the length of the alternate key.

name

public final String name()

The name of the alternate key.

Returns:

The name of the alternate key.

offset

public final Integer offset()

A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

Returns:

A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.

toBuilder

public AlternateKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AlternateKey.Builder,AlternateKey>

builder

public static AlternateKey.Builder builder()

serializableBuilderClass

public static Class<? extends AlternateKey.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo