Class ApiKeyCredentialProvider

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.ApiKeyCredentialProvider
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ApiKeyCredentialProvider.Builder,ApiKeyCredentialProvider>
@Generated("software.amazon.awssdk:codegen") public final class ApiKeyCredentialProvider extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApiKeyCredentialProvider.Builder,ApiKeyCredentialProvider>

An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.

See Also:

  • Method Details

    • providerArn

      public final String providerArn()

      The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.

      Returns:
      The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.

    • credentialParameterName

      public final String credentialParameterName()

      The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

      Returns:
      The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

    • credentialPrefix

      public final String credentialPrefix()

      The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

      Returns:
      The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.

    • credentialLocation

      public final ApiKeyCredentialLocation credentialLocation()

      The location of the API key credential. This field specifies where in the request the API key should be placed.

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

      Returns:
      The location of the API key credential. This field specifies where in the request the API key should be placed.
      See Also:

    • credentialLocationAsString

      public final String credentialLocationAsString()

      The location of the API key credential. This field specifies where in the request the API key should be placed.

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

      Returns:
      The location of the API key credential. This field specifies where in the request the API key should be placed.
      See Also:

    • toBuilder

      public ApiKeyCredentialProvider.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ApiKeyCredentialProvider.Builder,ApiKeyCredentialProvider>
      Returns:
      a builder for type T

    • builder

      public static ApiKeyCredentialProvider.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.