Interface HttpGatewayRouteMatch

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.085Z") @Stability(Stable) public interface HttpGatewayRouteMatch extends
The criterion for determining a request match for this GatewayRoute.


 VirtualGateway gateway;
 VirtualService virtualService;
 gateway.addGatewayRoute("gateway-route-http-2", GatewayRouteBaseProps.builder()
                         // This rewrites the path from '/test' to '/rewrittenPath'.
                         .path(HttpGatewayRoutePathMatch.exactly("/test", "/rewrittenPath"))
  • Method Details

    • getHeaders

      @Stability(Stable) @Nullable default List<HeaderMatch> getHeaders()
      Specifies the client request headers to match on.

      All specified headers must match for the gateway route to match.

      Default: - do not match on headers

    • getHostname

      @Stability(Stable) @Nullable default GatewayRouteHostnameMatch getHostname()
      The gateway route host name to be matched on.

      Default: - do not match on host name

    • getMethod

      @Stability(Stable) @Nullable default HttpRouteMethod getMethod()
      The method to match on.

      Default: - do not match on method

    • getPath

      @Stability(Stable) @Nullable default HttpGatewayRoutePathMatch getPath()
      Specify how to match requests based on the 'path' part of their URL.

      Default: - matches requests with any path

    • getQueryParameters

      @Stability(Stable) @Nullable default List<QueryParameterMatch> getQueryParameters()
      The query parameters to match on.

      All specified query parameters must match for the route to match.

      Default: - do not match on query parameters

    • getRewriteRequestHostname

      @Stability(Stable) @Nullable default Boolean getRewriteRequestHostname()
      When true, rewrites the original request received at the Virtual Gateway to the destination Virtual Service name.

      When false, retains the original hostname from the request.

      Default: true

    • builder

      @Stability(Stable) static HttpGatewayRouteMatch.Builder builder()
      a HttpGatewayRouteMatch.Builder of HttpGatewayRouteMatch