Interface RegisterCapabilityResponse.Builder

All Superinterfaces:

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

Enclosing class:

RegisterCapabilityResponse

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

Method Summary

Modifier and Type	Method	Description
RegisterCapabilityResponse.Builder	applicationId(String applicationId)	The unique identifier of the OpenSearch UI application.
default RegisterCapabilityResponse.Builder	capabilityConfig(Consumer<CapabilityBaseResponseConfig.Builder> capabilityConfig)	The configuration settings for the registered capability.
RegisterCapabilityResponse.Builder	capabilityConfig(CapabilityBaseResponseConfig capabilityConfig)	The configuration settings for the registered capability.
RegisterCapabilityResponse.Builder	capabilityName(String capabilityName)	The name of the registered capability.
RegisterCapabilityResponse.Builder	status(String status)	The current status of the capability.
RegisterCapabilityResponse.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

RegisterCapabilityResponse.Builder capabilityName(String capabilityName)

The name of the registered capability.

Parameters:

capabilityName - The name of the registered capability.

Returns:

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

applicationId

RegisterCapabilityResponse.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

RegisterCapabilityResponse.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

RegisterCapabilityResponse.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

RegisterCapabilityResponse.Builder capabilityConfig(CapabilityBaseResponseConfig capabilityConfig)

The configuration settings for the registered capability.

Parameters:

capabilityConfig - The configuration settings for the registered capability.

Returns:

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

capabilityConfig

default RegisterCapabilityResponse.Builder capabilityConfig(Consumer<CapabilityBaseResponseConfig.Builder> capabilityConfig)

The configuration settings for the registered capability.

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

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

Parameters:

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

Returns:

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

See Also:

• capabilityConfig(CapabilityBaseResponseConfig)