Class HarnessGatewayOutboundAuth

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

Authentication method for calling a Gateway.

See Also:

  • Method Details

    • awsIam

      public final Unit awsIam()

      SigV4-sign requests using the agent's execution role.

      Returns:
      SigV4-sign requests using the agent's execution role.

    • none

      public final Unit none()

      No authentication.

      Returns:
      No authentication.

    • oauth

      public final OAuthCredentialProvider oauth()

      OAuth 2.0 authentication via AgentCore Identity.

      Returns:
      OAuth 2.0 authentication via AgentCore Identity.

    • toBuilder

      public HarnessGatewayOutboundAuth.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<HarnessGatewayOutboundAuth.Builder,HarnessGatewayOutboundAuth>
      Returns:
      a builder for type T

    • builder

      public static HarnessGatewayOutboundAuth.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HarnessGatewayOutboundAuth.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)

    • fromAwsIam

      public static HarnessGatewayOutboundAuth fromAwsIam(Unit awsIam)
      Create an instance of this class with awsIam() initialized to the given value.

      SigV4-sign requests using the agent's execution role.

      Parameters:
      awsIam - SigV4-sign requests using the agent's execution role.

    • fromAwsIam

      public static HarnessGatewayOutboundAuth fromAwsIam(Consumer<Unit.Builder> awsIam)
      Create an instance of this class with awsIam() initialized to the given value.

      SigV4-sign requests using the agent's execution role.

      Parameters:
      awsIam - SigV4-sign requests using the agent's execution role.

    • fromNone

      public static HarnessGatewayOutboundAuth fromNone(Unit none)
      Create an instance of this class with none() initialized to the given value.

      No authentication.

      Parameters:
      none - No authentication.

    • fromNone

      public static HarnessGatewayOutboundAuth fromNone(Consumer<Unit.Builder> none)
      Create an instance of this class with none() initialized to the given value.

      No authentication.

      Parameters:
      none - No authentication.

    • fromOauth

      public static HarnessGatewayOutboundAuth fromOauth(OAuthCredentialProvider oauth)
      Create an instance of this class with oauth() initialized to the given value.

      OAuth 2.0 authentication via AgentCore Identity.

      Parameters:
      oauth - OAuth 2.0 authentication via AgentCore Identity.

    • fromOauth

      public static HarnessGatewayOutboundAuth fromOauth(Consumer<OAuthCredentialProvider.Builder> oauth)
      Create an instance of this class with oauth() initialized to the given value.

      OAuth 2.0 authentication via AgentCore Identity.

      Parameters:
      oauth - OAuth 2.0 authentication via AgentCore Identity.

    • type

      public HarnessGatewayOutboundAuth.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be HarnessGatewayOutboundAuth.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be HarnessGatewayOutboundAuth.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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