Skip to content

HttpGatewayRouteMatch

Source code in docs_src/capo_app_mesh/types/http_gateway_route_match.py
class HttpGatewayRouteMatch(TypedDict, closed=True):
    prefix: NotRequired["str"]
    """<p>Specifies the path to match requests with. This parameter must always start with <code>/</code>, 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 <code>my-service.local</code> and you want the route to match requests to <code>my-service.local/metrics</code>, your prefix should be <code>/metrics</code>.</p>"""
    path: NotRequired["capo_app_mesh.types.http_path_match.HttpPathMatch"]
    """<p>The path to match on.</p>"""
    query_parameters: NotRequired[
        "capo_app_mesh.types.http_query_parameters.HttpQueryParameters"
    ]
    """<p>The query parameter to match on.</p>"""
    method: NotRequired["capo_app_mesh.types.http_method.HttpMethod"]
    """<p>The method to match on.</p>"""
    hostname: NotRequired[
        "capo_app_mesh.types.gateway_route_hostname_match.GatewayRouteHostnameMatch"
    ]
    """<p>The host name to match on.</p>"""
    headers: NotRequired[
        "capo_app_mesh.types.http_gateway_route_headers.HttpGatewayRouteHeaders"
    ]
    """<p>The client request headers to match on.</p>"""
    port: NotRequired["capo_app_mesh.types.listener_port.ListenerPort"]
    """<p>The port number to match on.</p>"""

headers instance-attribute

headers: NotRequired[HttpGatewayRouteHeaders]

The client request headers to match on.

hostname instance-attribute

hostname: NotRequired[GatewayRouteHostnameMatch]

The host name to match on.

method instance-attribute

method: NotRequired[HttpMethod]

The method to match on.

path instance-attribute

path: NotRequired[HttpPathMatch]

The path to match on.

port instance-attribute

port: NotRequired[ListenerPort]

The port number to match on.

prefix instance-attribute

prefix: NotRequired[str]

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.

query_parameters instance-attribute

query_parameters: NotRequired[HttpQueryParameters]

The query parameter to match on.