Package software.amazon.awscdk.services.opensearchserverless

Class CfnIndex.PropertyMappingProperty.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchserverless.CfnIndex.PropertyMappingProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndex.PropertyMappingProperty>

Enclosing interface:

CfnIndex.PropertyMappingProperty

@Stability(Stable)
public static final class CfnIndex.PropertyMappingProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIndex.PropertyMappingProperty>

A builder for CfnIndex.PropertyMappingProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIndex.PropertyMappingProperty.Builder	analyzer(String analyzer)	Sets the value of CfnIndex.PropertyMappingProperty.getAnalyzer()
CfnIndex.PropertyMappingProperty	build()	Builds the configured instance.
CfnIndex.PropertyMappingProperty.Builder	compressionLevel(String compressionLevel)	Sets the value of CfnIndex.PropertyMappingProperty.getCompressionLevel()
CfnIndex.PropertyMappingProperty.Builder	dimension(Number dimension)	Sets the value of CfnIndex.PropertyMappingProperty.getDimension()
CfnIndex.PropertyMappingProperty.Builder	index(Boolean index)	Sets the value of CfnIndex.PropertyMappingProperty.getIndex()
CfnIndex.PropertyMappingProperty.Builder	index(IResolvable index)	Sets the value of CfnIndex.PropertyMappingProperty.getIndex()
CfnIndex.PropertyMappingProperty.Builder	method(IResolvable method)	Sets the value of CfnIndex.PropertyMappingProperty.getMethod()
CfnIndex.PropertyMappingProperty.Builder	method(CfnIndex.MethodProperty method)	Sets the value of CfnIndex.PropertyMappingProperty.getMethod()
CfnIndex.PropertyMappingProperty.Builder	properties(Map<String,? extends Object> properties)	Sets the value of CfnIndex.PropertyMappingProperty.getProperties()
CfnIndex.PropertyMappingProperty.Builder	properties(IResolvable properties)	Sets the value of CfnIndex.PropertyMappingProperty.getProperties()
CfnIndex.PropertyMappingProperty.Builder	spaceType(String spaceType)	Sets the value of CfnIndex.PropertyMappingProperty.getSpaceType()
CfnIndex.PropertyMappingProperty.Builder	type(String type)	Sets the value of CfnIndex.PropertyMappingProperty.getType()
CfnIndex.PropertyMappingProperty.Builder	value(String value)	Sets the value of CfnIndex.PropertyMappingProperty.getValue()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

type

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder type(String type)

Sets the value of CfnIndex.PropertyMappingProperty.getType()

Parameters:

type - The field data type. This parameter is required. Must be a valid OpenSearch field type.

Returns:

this

analyzer

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder analyzer(String analyzer)

Sets the value of CfnIndex.PropertyMappingProperty.getAnalyzer()

Parameters:

analyzer - The analyzer to use for this field (for text and keyword fields).

Returns:

this

compressionLevel

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder compressionLevel(String compressionLevel)

Sets the value of CfnIndex.PropertyMappingProperty.getCompressionLevel()

Parameters:

compressionLevel - The compression level for knn_vector fields.

Returns:

this

dimension

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder dimension(Number dimension)

Sets the value of CfnIndex.PropertyMappingProperty.getDimension()

Parameters:

dimension - Dimension size for vector fields, defines the number of dimensions in the vector.

Returns:

this

index

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder index(Boolean index)

Sets the value of CfnIndex.PropertyMappingProperty.getIndex()

Parameters:

index - Whether a field should be indexed.

Returns:

this

index

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder index(IResolvable index)

Sets the value of CfnIndex.PropertyMappingProperty.getIndex()

Parameters:

index - Whether a field should be indexed.

Returns:

this

method

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder method(IResolvable method)

Sets the value of CfnIndex.PropertyMappingProperty.getMethod()

Parameters:

method - Configuration for k-NN search method.

Returns:

this

method

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder method(CfnIndex.MethodProperty method)

Sets the value of CfnIndex.PropertyMappingProperty.getMethod()

Parameters:

method - Configuration for k-NN search method.

Returns:

this

properties

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder properties(IResolvable properties)

Sets the value of CfnIndex.PropertyMappingProperty.getProperties()

Parameters:

properties - Defines the fields within the mapping, including their types and configurations.

Returns:

this

properties

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder properties(Map<String,? extends Object> properties)

Sets the value of CfnIndex.PropertyMappingProperty.getProperties()

Parameters:

properties - Defines the fields within the mapping, including their types and configurations.

Returns:

this

spaceType

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder spaceType(String spaceType)

Sets the value of CfnIndex.PropertyMappingProperty.getSpaceType()

Parameters:

spaceType - The distance function used for k-NN search (field-level, outside Method).

Returns:

this

value

@Stability(Stable)
public CfnIndex.PropertyMappingProperty.Builder value(String value)

Sets the value of CfnIndex.PropertyMappingProperty.getValue()

Parameters:

value - Default value for the field when not specified in a document.

Returns:

this

build

@Stability(Stable)
public CfnIndex.PropertyMappingProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnIndex.PropertyMappingProperty>

Returns:

a new instance of CfnIndex.PropertyMappingProperty

Throws:

NullPointerException - if any required attribute was not provided