Class PassthroughTargetConfiguration

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

The configuration for an HTTP passthrough target. A passthrough target forwards requests directly to an external HTTP endpoint.

See Also:

  • Method Details

    • endpoint

      public final String endpoint()

      The HTTPS endpoint that the gateway forwards requests to for this passthrough target.

      Returns:
      The HTTPS endpoint that the gateway forwards requests to for this passthrough target.

    • protocolType

      public final PassthroughProtocolType protocolType()

      The application protocol that the passthrough target implements. This value is required for passthrough targets:

      • MCP - The Model Context Protocol.

      • A2A - The Agent-to-Agent protocol.

      • INFERENCE - The protocol for routing requests to a large language model (LLM) provider.

      • CUSTOM - A custom application protocol.

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

      Returns:
      The application protocol that the passthrough target implements. This value is required for passthrough targets:

      • MCP - The Model Context Protocol.

      • A2A - The Agent-to-Agent protocol.

      • INFERENCE - The protocol for routing requests to a large language model (LLM) provider.

      • CUSTOM - A custom application protocol.

      See Also:

    • protocolTypeAsString

      public final String protocolTypeAsString()

      The application protocol that the passthrough target implements. This value is required for passthrough targets:

      • MCP - The Model Context Protocol.

      • A2A - The Agent-to-Agent protocol.

      • INFERENCE - The protocol for routing requests to a large language model (LLM) provider.

      • CUSTOM - A custom application protocol.

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

      Returns:
      The application protocol that the passthrough target implements. This value is required for passthrough targets:

      • MCP - The Model Context Protocol.

      • A2A - The Agent-to-Agent protocol.

      • INFERENCE - The protocol for routing requests to a large language model (LLM) provider.

      • CUSTOM - A custom application protocol.

      See Also:

    • schema

      public final HttpApiSchemaConfiguration schema()

      The API schema configuration that defines the structure of the passthrough target's API.

      Returns:
      The API schema configuration that defines the structure of the passthrough target's API.

    • stickinessConfiguration

      public final StickinessConfiguration stickinessConfiguration()

      The session stickiness configuration for the passthrough target. This configuration routes requests within the same session to the same target.

      Returns:
      The session stickiness configuration for the passthrough target. This configuration routes requests within the same session to the same target.

    • hasStaticQueryParameters

      public final boolean hasStaticQueryParameters()
      For responses, this returns true if the service returned a value for the StaticQueryParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • staticQueryParameters

      public final Map<String,String> staticQueryParameters()

      A map of static query parameters that the gateway always appends to the outbound URL when forwarding requests to the target. The total outbound URL length, which includes the endpoint and the percent-encoded query parameters, is enforced by the service.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStaticQueryParameters() method.

      Returns:
      A map of static query parameters that the gateway always appends to the outbound URL when forwarding requests to the target. The total outbound URL length, which includes the endpoint and the percent-encoded query parameters, is enforced by the service.

    • staticQueryParameterConflictResolution

      public final StaticQueryParameterConflictResolution staticQueryParameterConflictResolution()

      Controls precedence when a client request supplies a query parameter whose name matches a configured static query parameter. If not set, defaults to CLIENT_OVERRIDE:

      • CLIENT_OVERRIDE - The client-supplied value overrides the configured static value for that parameter name.

      • STATIC_OVERRIDE - The configured static value is retained, overriding the client-supplied value for that parameter name.

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

      Returns:
      Controls precedence when a client request supplies a query parameter whose name matches a configured static query parameter. If not set, defaults to CLIENT_OVERRIDE:

      • CLIENT_OVERRIDE - The client-supplied value overrides the configured static value for that parameter name.

      • STATIC_OVERRIDE - The configured static value is retained, overriding the client-supplied value for that parameter name.

      See Also:

    • staticQueryParameterConflictResolutionAsString

      public final String staticQueryParameterConflictResolutionAsString()

      Controls precedence when a client request supplies a query parameter whose name matches a configured static query parameter. If not set, defaults to CLIENT_OVERRIDE:

      • CLIENT_OVERRIDE - The client-supplied value overrides the configured static value for that parameter name.

      • STATIC_OVERRIDE - The configured static value is retained, overriding the client-supplied value for that parameter name.

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

      Returns:
      Controls precedence when a client request supplies a query parameter whose name matches a configured static query parameter. If not set, defaults to CLIENT_OVERRIDE:

      • CLIENT_OVERRIDE - The client-supplied value overrides the configured static value for that parameter name.

      • STATIC_OVERRIDE - The configured static value is retained, overriding the client-supplied value for that parameter name.

      See Also:

    • toBuilder

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

    • builder

      public static PassthroughTargetConfiguration.Builder builder()

    • serializableBuilderClass

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