Interface RegisterCapabilityRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RegisterCapabilityRequest.Builder,RegisterCapabilityRequest>, OpenSearchRequest.Builder, SdkBuilder<RegisterCapabilityRequest.Builder,RegisterCapabilityRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RegisterCapabilityRequest

@Mutable
@NotThreadSafe
public static interface RegisterCapabilityRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<RegisterCapabilityRequest.Builder,RegisterCapabilityRequest>

Method Summary

Modifier and Type	Method	Description
RegisterCapabilityRequest.Builder	applicationId(String applicationId)	The unique identifier of the OpenSearch UI application to register the capability for.
default RegisterCapabilityRequest.Builder	capabilityConfig(Consumer<CapabilityBaseRequestConfig.Builder> capabilityConfig)	The configuration settings for the capability being registered.
RegisterCapabilityRequest.Builder	capabilityConfig(CapabilityBaseRequestConfig capabilityConfig)	The configuration settings for the capability being registered.
RegisterCapabilityRequest.Builder	capabilityName(String capabilityName)	The name of the capability to register.
RegisterCapabilityRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
RegisterCapabilityRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.opensearch.model.OpenSearchRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

applicationId

RegisterCapabilityRequest.Builder applicationId(String applicationId)

The unique identifier of the OpenSearch UI application to register the capability for.

Parameters:

applicationId - The unique identifier of the OpenSearch UI application to register the capability for.

Returns:

Returns a reference to this object so that method calls can be chained together.

capabilityName

RegisterCapabilityRequest.Builder capabilityName(String capabilityName)

The name of the capability to register. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens. This identifies the type of capability being enabled for the application. For registering AI Assistant capability, use ai-capability

Parameters:

capabilityName - The name of the capability to register. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens. This identifies the type of capability being enabled for the application. For registering AI Assistant capability, use ai-capability

Returns:

Returns a reference to this object so that method calls can be chained together.

capabilityConfig

RegisterCapabilityRequest.Builder capabilityConfig(CapabilityBaseRequestConfig capabilityConfig)

The configuration settings for the capability being registered. This includes capability-specific settings such as AI configuration.

Parameters:

capabilityConfig - The configuration settings for the capability being registered. This includes capability-specific settings such as AI configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

capabilityConfig

default RegisterCapabilityRequest.Builder capabilityConfig(Consumer<CapabilityBaseRequestConfig.Builder> capabilityConfig)

The configuration settings for the capability being registered. This includes capability-specific settings such as AI configuration.

This is a convenience method that creates an instance of the CapabilityBaseRequestConfig.Builder avoiding the need to create one manually via CapabilityBaseRequestConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capabilityConfig(CapabilityBaseRequestConfig).

Parameters:

capabilityConfig - a consumer that will call methods on CapabilityBaseRequestConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• capabilityConfig(CapabilityBaseRequestConfig)

overrideConfiguration

RegisterCapabilityRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

RegisterCapabilityRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.