Class AwsServiceRequestConfiguration

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

The configuration for an AWS_SERVICE_REQUEST function. Contains the target service, target Region, and request parameters that the function uses to call an AWS service API. For more information, see AWS_SERVICE_REQUEST in the MediaTailor User Guide.

See Also:

  • Method Details

    • runtime

      public final RuntimeType runtime()

      The expression language used to evaluate expressions in the function configuration. The only supported value is JSONata.

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

      Returns:
      The expression language used to evaluate expressions in the function configuration. The only supported value is JSONata.
      See Also:

    • runtimeAsString

      public final String runtimeAsString()

      The expression language used to evaluate expressions in the function configuration. The only supported value is JSONata.

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

      Returns:
      The expression language used to evaluate expressions in the function configuration. The only supported value is JSONata.
      See Also:

    • hasOutput

      public final boolean hasOutput()
      For responses, this returns true if the service returned a value for the Output 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.

    • output

      public final Map<String,String> output()

      A map of output bindings. Each key is a namespaced output path, such as player_params.device_type. Each value is an expression that MediaTailor evaluates at runtime and can reference the response object from the target service. For more information, see JSONata expression reference in the MediaTailor User Guide.

      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 hasOutput() method.

      Returns:
      A map of output bindings. Each key is a namespaced output path, such as player_params.device_type. Each value is an expression that MediaTailor evaluates at runtime and can reference the response object from the target service. For more information, see JSONata expression reference in the MediaTailor User Guide.

    • methodType

      public final MethodType methodType()

      Specifies how the function sends the request to the target service. The value must match what the target service operation requires. Valid values:

      • GET – Retrieves data from the target service.

      • POST – Submits a request body to the target service.

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

      Returns:
      Specifies how the function sends the request to the target service. The value must match what the target service operation requires. Valid values:

      • GET – Retrieves data from the target service.

      • POST – Submits a request body to the target service.

      See Also:

    • methodTypeAsString

      public final String methodTypeAsString()

      Specifies how the function sends the request to the target service. The value must match what the target service operation requires. Valid values:

      • GET – Retrieves data from the target service.

      • POST – Submits a request body to the target service.

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

      Returns:
      Specifies how the function sends the request to the target service. The value must match what the target service operation requires. Valid values:

      • GET – Retrieves data from the target service.

      • POST – Submits a request body to the target service.

      See Also:

    • requestTimeoutMilliseconds

      public final Integer requestTimeoutMilliseconds()

      The maximum time, in milliseconds, that MediaTailor waits for a response from the AWS 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:
      The maximum time, in milliseconds, that MediaTailor waits for a response from the AWS 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.

    • url

      public final String url()

      An expression that evaluates to the endpoint URL for the target AWS service API operation. Use {%...%} delimiters for dynamic expressions. The URL must correspond to a valid endpoint for the service specified in TargetService. The maximum length after evaluation is 2,048 characters.

      Returns:
      An expression that evaluates to the endpoint URL for the target AWS service API operation. Use {%...%} delimiters for dynamic expressions. The URL must correspond to a valid endpoint for the service specified in TargetService. The maximum length after evaluation is 2,048 characters.

    • body

      public final String body()

      An expression that evaluates to the request body for the AWS service API call. The body must conform to the input format that the target service operation expects. Applies only when the target operation accepts a request body. The maximum size after evaluation is 64 KB.

      Returns:
      An expression that evaluates to the request body for the AWS service API call. The body must conform to the input format that the target service operation expects. Applies only when the target operation accepts a request body. The maximum size after evaluation is 64 KB.

    • hasHeaders

      public final boolean hasHeaders()
      For responses, this returns true if the service returned a value for the Headers 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.

    • headers

      public final 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 to the AWS service. Use this to pass any headers required by the target service operation. You can include a maximum of 50 headers.

      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 hasHeaders() method.

      Returns:
      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 to the AWS service. Use this to pass any headers required by the target service operation. You can include a maximum of 50 headers.

    • targetService

      public final String targetService()

      The AWS service to call. Valid value: elemental-inference (AWS Elemental Inference).

      Returns:
      The AWS service to call. Valid value: elemental-inference (AWS Elemental Inference).

    • targetRegion

      public final String targetRegion()

      The AWS Region for the target service. Specify a static Region code (for example, us-east-1) or a JSONata expression that resolves to a Region code at runtime (for example, {%inference.region%}).

      Returns:
      The AWS Region for the target service. Specify a static Region code (for example, us-east-1) or a JSONata expression that resolves to a Region code at runtime (for example, {%inference.region%}).

    • toBuilder

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

    • builder

      public static AwsServiceRequestConfiguration.Builder builder()

    • serializableBuilderClass

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