Package software.amazon.awssdk.services.opensearch.model

Class CreateIndexRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearch.model.OpenSearchRequest

software.amazon.awssdk.services.opensearch.model.CreateIndexRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateIndexRequest
extends OpenSearchRequest
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	domainName()	Returns the value of the DomainName property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexName()	The name of the index to create.
Document	indexSchema()	The JSON schema defining index mappings, settings, and semantic enrichment configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
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

domainName

public final String domainName()

Returns the value of the DomainName property for this object.

Returns:

The value of the DomainName property for this object.

indexName

public final String indexName()

The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions.

Returns:

The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions.

indexSchema

public final Document indexSchema()

The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters.

Returns:

The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters.

toBuilder

public CreateIndexRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Specified by:

toBuilder in class OpenSearchRequest

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo