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

Class RegisterCapabilityResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.opensearch.model.OpenSearchResponse

software.amazon.awssdk.services.opensearch.model.RegisterCapabilityResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterCapabilityResponse.Builder,RegisterCapabilityResponse>

@Generated("software.amazon.awssdk:codegen")
public final class RegisterCapabilityResponse
extends OpenSearchResponse
implements ToCopyableBuilder<RegisterCapabilityResponse.Builder,RegisterCapabilityResponse>

The result of a RegisterCapability request. Contains details about the registered capability.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisterCapabilityResponse.Builder

Method Summary

Modifier and Type	Method	Description
final String	applicationId()	The unique identifier of the OpenSearch UI application.
static RegisterCapabilityResponse.Builder	builder()
final CapabilityBaseResponseConfig	capabilityConfig()	The configuration settings for the registered capability.
final String	capabilityName()	The name of the registered capability.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
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 RegisterCapabilityResponse.Builder>	serializableBuilderClass()
final CapabilityStatus	status()	The current status of the capability.
final String	statusAsString()	The current status of the capability.
RegisterCapabilityResponse.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.opensearch.model.OpenSearchResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

capabilityName

public final String capabilityName()

The name of the registered capability.

Returns:

The name of the registered capability.

applicationId

public final String applicationId()

The unique identifier of the OpenSearch UI application.

Returns:

The unique identifier of the OpenSearch UI application.

status

public final CapabilityStatus status()

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

If the service returns an enum value that is not available in the current SDK version, status will return CapabilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

• CapabilityStatus

statusAsString

public final String statusAsString()

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

If the service returns an enum value that is not available in the current SDK version, status will return CapabilityStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

• CapabilityStatus

capabilityConfig

public final CapabilityBaseResponseConfig capabilityConfig()

The configuration settings for the registered capability.

Returns:

The configuration settings for the registered capability.

toBuilder

public RegisterCapabilityResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterCapabilityResponse.Builder,RegisterCapabilityResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static RegisterCapabilityResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

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