Interface PassthroughTargetConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PassthroughTargetConfiguration.Builder,PassthroughTargetConfiguration>, SdkBuilder<PassthroughTargetConfiguration.Builder,PassthroughTargetConfiguration>, SdkPojo
Enclosing class:
PassthroughTargetConfiguration
@Mutable @NotThreadSafe public static interface PassthroughTargetConfiguration.Builder extends SdkPojo, CopyableBuilder<PassthroughTargetConfiguration.Builder,PassthroughTargetConfiguration>

  • Method Details

    • endpoint

      PassthroughTargetConfiguration.Builder endpoint(String endpoint)

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

      Parameters:
      endpoint - The HTTPS endpoint that the gateway forwards requests to for this passthrough target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocolType

      PassthroughTargetConfiguration.Builder protocolType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocolType

      PassthroughTargetConfiguration.Builder protocolType(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schema

      PassthroughTargetConfiguration.Builder schema(HttpApiSchemaConfiguration schema)

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

      Parameters:
      schema - The API schema configuration that defines the structure of the passthrough target's API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schema

      default PassthroughTargetConfiguration.Builder schema(Consumer<HttpApiSchemaConfiguration.Builder> schema)

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

      This is a convenience method that creates an instance of the HttpApiSchemaConfiguration.Builder avoiding the need to create one manually via HttpApiSchemaConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schema(HttpApiSchemaConfiguration).

      Parameters:
      schema - a consumer that will call methods on HttpApiSchemaConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stickinessConfiguration

      PassthroughTargetConfiguration.Builder stickinessConfiguration(StickinessConfiguration stickinessConfiguration)

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

      Parameters:
      stickinessConfiguration - The session stickiness configuration for the passthrough target. This configuration routes requests within the same session to the same target.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stickinessConfiguration

      default PassthroughTargetConfiguration.Builder stickinessConfiguration(Consumer<StickinessConfiguration.Builder> stickinessConfiguration)

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

      This is a convenience method that creates an instance of the StickinessConfiguration.Builder avoiding the need to create one manually via StickinessConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stickinessConfiguration(StickinessConfiguration).

      Parameters:
      stickinessConfiguration - a consumer that will call methods on StickinessConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • staticQueryParameters

      PassthroughTargetConfiguration.Builder staticQueryParameters(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • staticQueryParameterConflictResolution

      PassthroughTargetConfiguration.Builder staticQueryParameterConflictResolution(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • staticQueryParameterConflictResolution

      PassthroughTargetConfiguration.Builder staticQueryParameterConflictResolution(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: