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

Class RegisterCapabilityRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.opensearch.model.OpenSearchRequest
software.amazon.awssdk.services.opensearch.model.RegisterCapabilityRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RegisterCapabilityRequest.Builder,RegisterCapabilityRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterCapabilityRequest extends OpenSearchRequest implements ToCopyableBuilder<RegisterCapabilityRequest.Builder,RegisterCapabilityRequest>

Container for the parameters to the RegisterCapability operation.

  • Method Details

    • applicationId

      public final String applicationId()

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

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

    • capabilityName

      public final 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

      Returns:
      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

    • capabilityConfig

      public final CapabilityBaseRequestConfig capabilityConfig()

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

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

    • toBuilder

      public RegisterCapabilityRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<RegisterCapabilityRequest.Builder,RegisterCapabilityRequest>
      Specified by:
      toBuilder in class OpenSearchRequest

    • builder

      public static RegisterCapabilityRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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 SdkRequest

    • 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