Class HttpRequest

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

HTTP request configuration parameters that define how MediaTailor communicates with the ad decision server.

See Also:

  • Method Details

    • method

      public final Method method()

      The HTTP method to use when making requests to the ad decision server. Supported values are GET and POST.

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

      Returns:
      The HTTP method to use when making requests to the ad decision server. Supported values are GET and POST.
      See Also:

    • methodAsString

      public final String methodAsString()

      The HTTP method to use when making requests to the ad decision server. Supported values are GET and POST.

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

      Returns:
      The HTTP method to use when making requests to the ad decision server. Supported values are GET and POST.
      See Also:

    • body

      public final String body()

      The request body content to send with HTTP requests to the ad decision server. This value is only eligible for POST requests.

      Returns:
      The request body content to send with HTTP requests to the ad decision server. This value is only eligible for POST requests.

    • 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()

      Custom HTTP headers to include in requests to the ad decision server. Specify headers as key-value pairs. This value is only eligible for POST requests.

      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:
      Custom HTTP headers to include in requests to the ad decision server. Specify headers as key-value pairs. This value is only eligible for POST requests.

    • compressRequest

      public final CompressionMethod compressRequest()

      The compression method to apply to requests sent to the ad decision server. Supported values are NONE and GZIP. This value is only eligible for POST requests.

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

      Returns:
      The compression method to apply to requests sent to the ad decision server. Supported values are NONE and GZIP. This value is only eligible for POST requests.
      See Also:

    • compressRequestAsString

      public final String compressRequestAsString()

      The compression method to apply to requests sent to the ad decision server. Supported values are NONE and GZIP. This value is only eligible for POST requests.

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

      Returns:
      The compression method to apply to requests sent to the ad decision server. Supported values are NONE and GZIP. This value is only eligible for POST requests.
      See Also:

    • toBuilder

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

    • builder

      public static HttpRequest.Builder builder()

    • serializableBuilderClass

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