Interface PutFunctionRequest.Builder

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

  • Method Details

    • functionId

      PutFunctionRequest.Builder functionId(String functionId)

      The identifier of the function. The identifier must be unique within your account.

      Parameters:
      functionId - The identifier of the function. The identifier must be unique within your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • functionType

      PutFunctionRequest.Builder functionType(String functionType)

      The type of the function, which determines what the function can do at runtime. Valid values:

      • CUSTOM_OUTPUT – Evaluates expressions and produces output bindings with no external calls.

      • HTTP_REQUEST – Makes an HTTP call to an external service and evaluates output expressions that can reference the response.

      • AWS_SERVICE_REQUEST – Makes an authenticated request to a supported AWS service API and evaluates output expressions that can reference the response.

      • VAST_REQUEST – Calls a VAST endpoint, parses the response as VAST, and makes the parsed ads available to output expressions.

      • SEQUENTIAL_EXECUTOR – Runs a sequence of child functions in order, passing data between steps through temporary data.

      • CONCURRENT_EXECUTOR – Runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete.

      For more information, see Function types and composition in the MediaTailor User Guide.

      Parameters:
      functionType - The type of the function, which determines what the function can do at runtime. Valid values:

      • CUSTOM_OUTPUT – Evaluates expressions and produces output bindings with no external calls.

      • HTTP_REQUEST – Makes an HTTP call to an external service and evaluates output expressions that can reference the response.

      • AWS_SERVICE_REQUEST – Makes an authenticated request to a supported AWS service API and evaluates output expressions that can reference the response.

      • VAST_REQUEST – Calls a VAST endpoint, parses the response as VAST, and makes the parsed ads available to output expressions.

      • SEQUENTIAL_EXECUTOR – Runs a sequence of child functions in order, passing data between steps through temporary data.

      • CONCURRENT_EXECUTOR – Runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete.

      For more information, see Function types and composition in the MediaTailor User Guide.

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

    • functionType

      PutFunctionRequest.Builder functionType(FunctionType functionType)

      The type of the function, which determines what the function can do at runtime. Valid values:

      • CUSTOM_OUTPUT – Evaluates expressions and produces output bindings with no external calls.

      • HTTP_REQUEST – Makes an HTTP call to an external service and evaluates output expressions that can reference the response.

      • AWS_SERVICE_REQUEST – Makes an authenticated request to a supported AWS service API and evaluates output expressions that can reference the response.

      • VAST_REQUEST – Calls a VAST endpoint, parses the response as VAST, and makes the parsed ads available to output expressions.

      • SEQUENTIAL_EXECUTOR – Runs a sequence of child functions in order, passing data between steps through temporary data.

      • CONCURRENT_EXECUTOR – Runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete.

      For more information, see Function types and composition in the MediaTailor User Guide.

      Parameters:
      functionType - The type of the function, which determines what the function can do at runtime. Valid values:

      • CUSTOM_OUTPUT – Evaluates expressions and produces output bindings with no external calls.

      • HTTP_REQUEST – Makes an HTTP call to an external service and evaluates output expressions that can reference the response.

      • AWS_SERVICE_REQUEST – Makes an authenticated request to a supported AWS service API and evaluates output expressions that can reference the response.

      • VAST_REQUEST – Calls a VAST endpoint, parses the response as VAST, and makes the parsed ads available to output expressions.

      • SEQUENTIAL_EXECUTOR – Runs a sequence of child functions in order, passing data between steps through temporary data.

      • CONCURRENT_EXECUTOR – Runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete.

      For more information, see Function types and composition in the MediaTailor User Guide.

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

    • description

      PutFunctionRequest.Builder description(String description)

      A description of the function.

      Parameters:
      description - A description of the function.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpRequestConfiguration

      PutFunctionRequest.Builder httpRequestConfiguration(HttpRequestConfiguration httpRequestConfiguration)

      The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is HTTP_REQUEST.

      Parameters:
      httpRequestConfiguration - The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is HTTP_REQUEST.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpRequestConfiguration

      default PutFunctionRequest.Builder httpRequestConfiguration(Consumer<HttpRequestConfiguration.Builder> httpRequestConfiguration)

      The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is HTTP_REQUEST.

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

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

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

    • awsServiceRequestConfiguration

      PutFunctionRequest.Builder awsServiceRequestConfiguration(AwsServiceRequestConfiguration awsServiceRequestConfiguration)

      The configuration for an AWS_SERVICE_REQUEST function. You must specify this parameter when FunctionType is AWS_SERVICE_REQUEST.

      Parameters:
      awsServiceRequestConfiguration - The configuration for an AWS_SERVICE_REQUEST function. You must specify this parameter when FunctionType is AWS_SERVICE_REQUEST.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsServiceRequestConfiguration

      default PutFunctionRequest.Builder awsServiceRequestConfiguration(Consumer<AwsServiceRequestConfiguration.Builder> awsServiceRequestConfiguration)

      The configuration for an AWS_SERVICE_REQUEST function. You must specify this parameter when FunctionType is AWS_SERVICE_REQUEST.

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

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

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

    • customOutputConfiguration

      PutFunctionRequest.Builder customOutputConfiguration(CustomOutputConfiguration customOutputConfiguration)

      The configuration for a CUSTOM_OUTPUT function. Specifies the runtime and output expressions. Required when FunctionType is CUSTOM_OUTPUT.

      Parameters:
      customOutputConfiguration - The configuration for a CUSTOM_OUTPUT function. Specifies the runtime and output expressions. Required when FunctionType is CUSTOM_OUTPUT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customOutputConfiguration

      default PutFunctionRequest.Builder customOutputConfiguration(Consumer<CustomOutputConfiguration.Builder> customOutputConfiguration)

      The configuration for a CUSTOM_OUTPUT function. Specifies the runtime and output expressions. Required when FunctionType is CUSTOM_OUTPUT.

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

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

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

    • concurrentExecutorConfiguration

      PutFunctionRequest.Builder concurrentExecutorConfiguration(ConcurrentExecutorConfiguration concurrentExecutorConfiguration)

      The configuration for a CONCURRENT_EXECUTOR function. Specifies the list of child functions to run in parallel, the maximum concurrency, an optional output block, and a timeout. Required when FunctionType is CONCURRENT_EXECUTOR.

      Parameters:
      concurrentExecutorConfiguration - The configuration for a CONCURRENT_EXECUTOR function. Specifies the list of child functions to run in parallel, the maximum concurrency, an optional output block, and a timeout. Required when FunctionType is CONCURRENT_EXECUTOR.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • concurrentExecutorConfiguration

      default PutFunctionRequest.Builder concurrentExecutorConfiguration(Consumer<ConcurrentExecutorConfiguration.Builder> concurrentExecutorConfiguration)

      The configuration for a CONCURRENT_EXECUTOR function. Specifies the list of child functions to run in parallel, the maximum concurrency, an optional output block, and a timeout. Required when FunctionType is CONCURRENT_EXECUTOR.

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

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

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

    • sequentialExecutorConfiguration

      PutFunctionRequest.Builder sequentialExecutorConfiguration(SequentialExecutorConfiguration sequentialExecutorConfiguration)

      The configuration for a SEQUENTIAL_EXECUTOR function. Specifies the ordered list of child functions to execute, an optional output block, and a timeout. Required when FunctionType is SEQUENTIAL_EXECUTOR.

      Parameters:
      sequentialExecutorConfiguration - The configuration for a SEQUENTIAL_EXECUTOR function. Specifies the ordered list of child functions to execute, an optional output block, and a timeout. Required when FunctionType is SEQUENTIAL_EXECUTOR.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sequentialExecutorConfiguration

      default PutFunctionRequest.Builder sequentialExecutorConfiguration(Consumer<SequentialExecutorConfiguration.Builder> sequentialExecutorConfiguration)

      The configuration for a SEQUENTIAL_EXECUTOR function. Specifies the ordered list of child functions to execute, an optional output block, and a timeout. Required when FunctionType is SEQUENTIAL_EXECUTOR.

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

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

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

    • vastRequestConfiguration

      PutFunctionRequest.Builder vastRequestConfiguration(VastRequestConfiguration vastRequestConfiguration)

      The configuration for a VAST_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is VAST_REQUEST.

      Parameters:
      vastRequestConfiguration - The configuration for a VAST_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is VAST_REQUEST.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vastRequestConfiguration

      default PutFunctionRequest.Builder vastRequestConfiguration(Consumer<VastRequestConfiguration.Builder> vastRequestConfiguration)

      The configuration for a VAST_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions. Required when FunctionType is VAST_REQUEST.

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

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

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

    • tags

      PutFunctionRequest.Builder tags(Map<String,String> tags)

      The tags to assign to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

      Parameters:
      tags - The tags to assign to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutFunctionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutFunctionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.