Class PipeEnrichmentHttpParameters

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

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

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

      The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

      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 path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

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

      The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

      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 headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

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

      The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

      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 query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

    • toBuilder

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

    • builder

      public static PipeEnrichmentHttpParameters.Builder builder()

    • serializableBuilderClass

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