Interface VastRequestConfiguration.Builder

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

  • Method Details

    • runtime

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

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

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

      A map of output bindings. Each key is a namespaced output path (such as temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in a VAST_REQUEST function can reference the response object, which exposes response.parsedAds — the ads parsed from the VAST response after schema validation and wrapper resolution — and response.statusCode. 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 temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in a VAST_REQUEST function can reference the response object, which exposes response.parsedAds — the ads parsed from the VAST response after schema validation and wrapper resolution — and response.statusCode. 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

      VastRequestConfiguration.Builder methodType(String methodType)

      The HTTP method for the request to the VAST endpoint. Valid values: GET and POST. Use POST to send a bid request body, such as an OpenRTB payload.

      Parameters:
      methodType - The HTTP method for the request to the VAST endpoint. Valid values: GET and POST. Use POST to send a bid request body, such as an OpenRTB payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • methodType

      VastRequestConfiguration.Builder methodType(MethodType methodType)

      The HTTP method for the request to the VAST endpoint. Valid values: GET and POST. Use POST to send a bid request body, such as an OpenRTB payload.

      Parameters:
      methodType - The HTTP method for the request to the VAST endpoint. Valid values: GET and POST. Use POST to send a bid request body, such as an OpenRTB payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestTimeoutMilliseconds

      VastRequestConfiguration.Builder requestTimeoutMilliseconds(Integer requestTimeoutMilliseconds)

      The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values: 100 to 2000.

      Parameters:
      requestTimeoutMilliseconds - The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values: 100 to 2000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • url

      VastRequestConfiguration.Builder url(String url)

      An expression that evaluates to the VAST endpoint URL. Use {%...%} delimiters for dynamic expressions. A literal value must be an https:// URL. The maximum length is 25,000 characters.

      Parameters:
      url - An expression that evaluates to the VAST endpoint URL. Use {%...%} delimiters for dynamic expressions. A literal value must be an https:// URL. The maximum length is 25,000 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      VastRequestConfiguration.Builder body(String body)

      An expression that evaluates to the request body. Used with POST requests, for example to send an OpenRTB bid request. The maximum length is 100,000 characters.

      Parameters:
      body - An expression that evaluates to the request body. Used with POST requests, for example to send an OpenRTB bid request. The maximum length is 100,000 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

      VastRequestConfiguration.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 request. Headers beginning with X-Amz- are reserved by the service, and method override headers are not allowed.

      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 request. Headers beginning with X-Amz- are reserved by the service, and method override headers are not allowed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.