Interface GetCapabilityResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetCapabilityResponse.Builder,GetCapabilityResponse>, OpenSearchResponse.Builder, SdkBuilder<GetCapabilityResponse.Builder,GetCapabilityResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetCapabilityResponse

@Mutable
@NotThreadSafe
public static interface GetCapabilityResponse.Builder
extends OpenSearchResponse.Builder, SdkPojo, CopyableBuilder<GetCapabilityResponse.Builder,GetCapabilityResponse>

Method Summary

Modifier and Type	Method	Description
GetCapabilityResponse.Builder	applicationId(String applicationId)	The unique identifier of the OpenSearch UI application.
default GetCapabilityResponse.Builder	capabilityConfig(Consumer<CapabilityExtendedResponseConfig.Builder> capabilityConfig)	The configuration settings for the capability, including capability-specific settings such as AI configuration.
GetCapabilityResponse.Builder	capabilityConfig(CapabilityExtendedResponseConfig capabilityConfig)	The configuration settings for the capability, including capability-specific settings such as AI configuration.
GetCapabilityResponse.Builder	capabilityName(String capabilityName)	The name of the capability.
GetCapabilityResponse.Builder	failures(Collection<CapabilityFailure> failures)	A list of failures associated with the capability, if any.
GetCapabilityResponse.Builder	failures(Consumer<CapabilityFailure.Builder>... failures)	A list of failures associated with the capability, if any.
GetCapabilityResponse.Builder	failures(CapabilityFailure... failures)	A list of failures associated with the capability, if any.
GetCapabilityResponse.Builder	status(String status)	The current status of the capability.
GetCapabilityResponse.Builder	status(CapabilityStatus status)	The current status of the capability.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

capabilityName

GetCapabilityResponse.Builder capabilityName(String capabilityName)

The name of the capability.

Parameters:

capabilityName - The name of the capability.

Returns:

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

applicationId

GetCapabilityResponse.Builder applicationId(String applicationId)

The unique identifier of the OpenSearch UI application.

Parameters:

applicationId - The unique identifier of the OpenSearch UI application.

Returns:

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

status

GetCapabilityResponse.Builder status(String status)

The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

Parameters:

status - The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

Returns:

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

See Also:

• CapabilityStatus
• CapabilityStatus

status

GetCapabilityResponse.Builder status(CapabilityStatus status)

The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

Parameters:

status - The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

Returns:

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

See Also:

• CapabilityStatus
• CapabilityStatus

capabilityConfig

GetCapabilityResponse.Builder capabilityConfig(CapabilityExtendedResponseConfig capabilityConfig)

The configuration settings for the capability, including capability-specific settings such as AI configuration.

Parameters:

capabilityConfig - The configuration settings for the capability, including capability-specific settings such as AI configuration.

Returns:

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

capabilityConfig

default GetCapabilityResponse.Builder capabilityConfig(Consumer<CapabilityExtendedResponseConfig.Builder> capabilityConfig)

The configuration settings for the capability, including capability-specific settings such as AI configuration.

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

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

Parameters:

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

Returns:

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

See Also:

• capabilityConfig(CapabilityExtendedResponseConfig)

failures

GetCapabilityResponse.Builder failures(Collection<CapabilityFailure> failures)

A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

Parameters:

failures - A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

Returns:

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

failures

GetCapabilityResponse.Builder failures(CapabilityFailure... failures)

A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

Parameters:

failures - A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

Returns:

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

failures

GetCapabilityResponse.Builder failures(Consumer<CapabilityFailure.Builder>... failures)

A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failures(List<CapabilityFailure>).

Parameters:

failures - a consumer that will call methods on CapabilityFailure.Builder

Returns:

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

See Also:

• failures(java.util.Collection<CapabilityFailure>)