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

Class CapabilityBaseRequestConfig

java.lang.Object

software.amazon.awssdk.services.opensearch.model.CapabilityBaseRequestConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CapabilityBaseRequestConfig.Builder,CapabilityBaseRequestConfig>

@Generated("software.amazon.awssdk:codegen")
public final class CapabilityBaseRequestConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CapabilityBaseRequestConfig.Builder,CapabilityBaseRequestConfig>

The base configuration for registering a capability. Contains capability-specific configuration such as AI settings.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapabilityBaseRequestConfig.Builder
static enum	CapabilityBaseRequestConfig.Type

Method Summary

Modifier and Type	Method	Description
final AIConfig	aiConfig()	Configuration settings for AI-powered capabilities.
static CapabilityBaseRequestConfig.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
static CapabilityBaseRequestConfig	fromAiConfig(Consumer<AIConfig.Builder> aiConfig)	Create an instance of this class with aiConfig() initialized to the given value.
static CapabilityBaseRequestConfig	fromAiConfig(AIConfig aiConfig)	Create an instance of this class with aiConfig() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CapabilityBaseRequestConfig.Builder>	serializableBuilderClass()
CapabilityBaseRequestConfig.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
CapabilityBaseRequestConfig.Type	type()	Retrieve an enum value representing which member of this object is populated.

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 Details

aiConfig

public final AIConfig aiConfig()

Configuration settings for AI-powered capabilities.

Returns:

Configuration settings for AI-powered capabilities.

toBuilder

public CapabilityBaseRequestConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapabilityBaseRequestConfig.Builder,CapabilityBaseRequestConfig>

builder

public static CapabilityBaseRequestConfig.Builder builder()

serializableBuilderClass

public static Class<? extends CapabilityBaseRequestConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

fromAiConfig

public static CapabilityBaseRequestConfig fromAiConfig(AIConfig aiConfig)

Create an instance of this class with aiConfig() initialized to the given value.

Configuration settings for AI-powered capabilities.

Parameters:

aiConfig - Configuration settings for AI-powered capabilities.

fromAiConfig

public static CapabilityBaseRequestConfig fromAiConfig(Consumer<AIConfig.Builder> aiConfig)

Create an instance of this class with aiConfig() initialized to the given value.

Configuration settings for AI-powered capabilities.

Parameters:

aiConfig - Configuration settings for AI-powered capabilities.

type

public CapabilityBaseRequestConfig.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be CapabilityBaseRequestConfig.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be CapabilityBaseRequestConfig.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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