Class HttpGatewayRouteMatch

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

An object that represents the criteria for determining a request match.

See Also:

  • Method Details

    • 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 List<HttpGatewayRouteHeader> headers()

      The client request headers to match on.

      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:
      The client request headers to match on.

    • hostname

      public final GatewayRouteHostnameMatch hostname()

      The host name to match on.

      Returns:
      The host name to match on.

    • method

      public final HttpMethod method()

      The method to match on.

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

      Returns:
      The method to match on.
      See Also:

    • methodAsString

      public final String methodAsString()

      The method to match on.

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

      Returns:
      The method to match on.
      See Also:

    • path

      public final HttpPathMatch path()

      The path to match on.

      Returns:
      The path to match on.

    • port

      public final Integer port()

      The port number to match on.

      Returns:
      The port number to match on.

    • prefix

      public final String prefix()

      Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

      Returns:
      Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

    • hasQueryParameters

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

    • queryParameters

      public final List<HttpQueryParameter> queryParameters()

      The query parameter to match on.

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

      Returns:
      The query parameter to match on.

    • toBuilder

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

    • builder

      public static HttpGatewayRouteMatch.Builder builder()

    • serializableBuilderClass

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