Package software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless

Class CfnIndexPropsMixin.PropertyMappingProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.CfnIndexPropsMixin.PropertyMappingProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnIndexPropsMixin.PropertyMappingProperty

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

A builder for CfnIndexPropsMixin.PropertyMappingProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIndexPropsMixin.PropertyMappingProperty	build()	Builds the configured instance.
CfnIndexPropsMixin.PropertyMappingProperty.Builder	dimension(Number dimension)	Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getDimension()
CfnIndexPropsMixin.PropertyMappingProperty.Builder	index(Boolean index)	Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getIndex()
CfnIndexPropsMixin.PropertyMappingProperty.Builder	index(IResolvable index)	Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getIndex()
CfnIndexPropsMixin.PropertyMappingProperty.Builder	method(CfnIndexPropsMixin.MethodProperty method)	Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getMethod()
CfnIndexPropsMixin.PropertyMappingProperty.Builder	method(IResolvable method)	Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getMethod()
CfnIndexPropsMixin.PropertyMappingProperty.Builder	properties(Map<String,? extends Object> properties)	Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getProperties()
CfnIndexPropsMixin.PropertyMappingProperty.Builder	properties(IResolvable properties)	Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getProperties()
CfnIndexPropsMixin.PropertyMappingProperty.Builder	type(String type)	Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getType()
CfnIndexPropsMixin.PropertyMappingProperty.Builder	value(String value)	Sets the value of CfnIndexPropsMixin.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

dimension

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getDimension()

Parameters:

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

Returns:

this

index

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getIndex()

Parameters:

index - Whether a field should be indexed.

Returns:

this

index

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getIndex()

Parameters:

index - Whether a field should be indexed.

Returns:

this

method

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getMethod()

Parameters:

method - Configuration for k-NN search method.

Returns:

this

method

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getMethod()

Parameters:

method - Configuration for k-NN search method.

Returns:

this

properties

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getProperties()

Parameters:

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

Returns:

this

properties

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getProperties()

Parameters:

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

Returns:

this

type

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getType()

Parameters:

type - The field data type. Must be a valid OpenSearch field type.

Returns:

this

value

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

Sets the value of CfnIndexPropsMixin.PropertyMappingProperty.getValue()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnIndexPropsMixin.PropertyMappingProperty

Throws:

NullPointerException - if any required attribute was not provided