Package software.amazon.awscdk.services.opensearchserverless

Interface CfnIndex.MethodProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.MethodProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(Stable)
public static interface CfnIndex.MethodProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for k-NN search method.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchserverless.*;
 MethodProperty methodProperty = MethodProperty.builder()
         .name("name")
         // the properties below are optional
         .engine("engine")
         .parameters(ParametersProperty.builder()
                 .efConstruction(123)
                 .m(123)
                 .build())
         .spaceType("spaceType")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndex.MethodProperty.Builder	A builder for CfnIndex.MethodProperty
static final class	CfnIndex.MethodProperty.Jsii$Proxy	An implementation for CfnIndex.MethodProperty

Method Summary

Modifier and Type	Method	Description
static CfnIndex.MethodProperty.Builder	builder()
default String	getEngine()	The k-NN search engine to use.
String	getName()	The algorithm name for k-NN search.
default Object	getParameters()	Additional parameters for the k-NN algorithm.
default String	getSpaceType()	The distance function used for k-NN search.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The algorithm name for k-NN search.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-name

getEngine

@Stability(Stable)
@Nullable
default String getEngine()

The k-NN search engine to use.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-engine

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

Additional parameters for the k-NN algorithm.

Returns union: either IResolvable or CfnIndex.ParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-parameters

getSpaceType

@Stability(Stable)
@Nullable
default String getSpaceType()

The distance function used for k-NN search.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-spacetype

builder

@Stability(Stable)
static CfnIndex.MethodProperty.Builder builder()

Returns:

a CfnIndex.MethodProperty.Builder of CfnIndex.MethodProperty