Package software.amazon.awssdk.services.clouddirectory.model

Class CreateIndexRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.clouddirectory.model.CloudDirectoryRequest

software.amazon.awssdk.services.clouddirectory.model.CreateIndexRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateIndexRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateIndexRequest.Builder	builder()
String	directoryArn()	The ARN of the directory where the index should be created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOrderedIndexedAttributeList()	For responses, this returns true if the service returned a value for the OrderedIndexedAttributeList property.
Boolean	isUnique()	Indicates whether the attribute that is being indexed has unique values or not.
String	linkName()	The name of the link between the parent object and the index object.
List<AttributeKey>	orderedIndexedAttributeList()	Specifies the attributes that should be indexed on.
ObjectReference	parentReference()	A reference to the parent object that contains the index object.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateIndexRequest.Builder>	serializableBuilderClass()
CreateIndexRequest.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

directoryArn

public final String directoryArn()

The ARN of the directory where the index should be created.

Returns:

The ARN of the directory where the index should be created.

hasOrderedIndexedAttributeList

public final boolean hasOrderedIndexedAttributeList()

For responses, this returns true if the service returned a value for the OrderedIndexedAttributeList 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.

orderedIndexedAttributeList

public final List<AttributeKey> orderedIndexedAttributeList()

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

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

Returns:

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

isUnique

public final Boolean isUnique()

Indicates whether the attribute that is being indexed has unique values or not.

Returns:

Indicates whether the attribute that is being indexed has unique values or not.

parentReference

public final ObjectReference parentReference()

A reference to the parent object that contains the index object.

Returns:

A reference to the parent object that contains the index object.

linkName

public final String linkName()

The name of the link between the parent object and the index object.

Returns:

The name of the link between the parent object and the index object.

toBuilder

public CreateIndexRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Specified by:

toBuilder in class CloudDirectoryRequest

builder

public static CreateIndexRequest.Builder builder()

serializableBuilderClass

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