Interface HttpRequestConfiguration.Builder

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

  • Method Details

    • runtime

      HttpRequestConfiguration.Builder runtime(String runtime)

      The expression language used to evaluate expressions in the function configuration. Set this to JSONata.

      Parameters:
      runtime - The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • runtime

      HttpRequestConfiguration.Builder runtime(RuntimeType runtime)

      The expression language used to evaluate expressions in the function configuration. Set this to JSONata.

      Parameters:
      runtime - The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • output

      HttpRequestConfiguration.Builder output(Map<String,String> output)

      A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in an HTTP_REQUEST function can reference the response object returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.

      Parameters:
      output - A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in an HTTP_REQUEST function can reference the response object returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • methodType

      HttpRequestConfiguration.Builder methodType(String methodType)

      The HTTP method for the request. Valid values: GET and POST.

      Parameters:
      methodType - The HTTP method for the request. Valid values: GET and POST.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • methodType

      HttpRequestConfiguration.Builder methodType(MethodType methodType)

      The HTTP method for the request. Valid values: GET and POST.

      Parameters:
      methodType - The HTTP method for the request. Valid values: GET and POST.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestTimeoutMilliseconds

      HttpRequestConfiguration.Builder requestTimeoutMilliseconds(Integer requestTimeoutMilliseconds)

      The maximum time, in milliseconds, that MediaTailor waits for a response from the external service. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values: 100 to 2000.

      Parameters:
      requestTimeoutMilliseconds - The maximum time, in milliseconds, that MediaTailor waits for a response from the external service. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values: 100 to 2000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • url

      HttpRequestConfiguration.Builder url(String url)

      An expression that evaluates to the request URL. Use {%...%} delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.

      Parameters:
      url - An expression that evaluates to the request URL. Use {%...%} delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      HttpRequestConfiguration.Builder body(String body)

      An expression that evaluates to the request body. Used with POST requests. The maximum size after evaluation is 64 KB.

      Parameters:
      body - An expression that evaluates to the request body. Used with POST requests. The maximum size after evaluation is 64 KB.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

      HttpRequestConfiguration.Builder headers(Map<String,String> headers)

      A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound HTTP request. Maximum 50 headers.

      Parameters:
      headers - A map of HTTP header names to expression values. MediaTailor evaluates each header value expression at runtime and includes the result in the outbound HTTP request. Maximum 50 headers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.