Skip to content

UriPathRouteInput

Source code in docs_src/capo_migration_hub_refactor_spaces/types/uri_path_route_input.py
class UriPathRouteInput(TypedDict, closed=True):
    source_path: "capo_migration_hub_refactor_spaces.types.uri_path.UriPath"
    """<p>This is the path that Refactor Spaces uses to match traffic. Paths must start with <code>/</code> and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.</p>"""
    activation_state: "capo_migration_hub_refactor_spaces.types.route_activation_state.RouteActivationState"
    """<p>If set to <code>ACTIVE</code>, traffic is forwarded to this route’s service after the route is created. </p>"""
    methods: NotRequired[
        "capo_migration_hub_refactor_spaces.types.http_methods.HttpMethods"
    ]
    """<p>A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service. </p>"""
    include_child_paths: NotRequired[
        "capo_migration_hub_refactor_spaces.types.boolean.Boolean"
    ]
    """<p>Indicates whether to match all subpaths of the given source path. If this value is <code>false</code>, requests must match the source path exactly before they are forwarded to this route's service. </p>"""
    append_source_path: NotRequired[
        "capo_migration_hub_refactor_spaces.types.boolean.Boolean"
    ]
    """<p>If set to <code>true</code>, this option appends the source path to the service URL endpoint.</p>"""

activation_state instance-attribute

activation_state: RouteActivationState

If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

append_source_path instance-attribute

append_source_path: NotRequired[Boolean]

If set to true, this option appends the source path to the service URL endpoint.

include_child_paths instance-attribute

include_child_paths: NotRequired[Boolean]

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

methods instance-attribute

methods: NotRequired[HttpMethods]

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

source_path instance-attribute

source_path: UriPath

This is the path that Refactor Spaces uses to match traffic. Paths must start with / and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.