Class HttpParameters

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

HTTP invocation parameters for subscribers (API Gateway / API Destination). Values are forwarded to the HTTP endpoint.

See Also:

  • Method Details

    • hasPathParameterValues

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

    • pathParameterValues

      public final List<String> pathParameterValues()
      Returns the value of the PathParameterValues property for this object.

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

      Returns:
      The value of the PathParameterValues property for this object.

    • hasHeaderParameters

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

    • headerParameters

      public final Map<String,String> headerParameters()
      Returns the value of the HeaderParameters property for this object.

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

      Returns:
      The value of the HeaderParameters property for this object.

    • hasQueryStringParameters

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

    • queryStringParameters

      public final Map<String,String> queryStringParameters()
      Returns the value of the QueryStringParameters property for this object.

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

      Returns:
      The value of the QueryStringParameters property for this object.

    • invocationTimeoutSeconds

      public final String invocationTimeoutSeconds()

      Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.

      Returns:
      Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.

    • toBuilder

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

    • builder

      public static HttpParameters.Builder builder()

    • serializableBuilderClass

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