Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::PathMatcher (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::PathMatcher.

A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#default_custom_error_response_policy

def default_custom_error_response_policy() -> ::Google::Cloud::Compute::V1::CustomErrorResponsePolicy
Returns
  • (::Google::Cloud::Compute::V1::CustomErrorResponsePolicy) — defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error.

    This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels likeRouteRule and PathRule within thisPathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect.

    For example, consider a UrlMap with the following configuration:

     - UrlMap.defaultCustomErrorResponsePolicy is configured
 with policies for 5xx and 4xx errors
 - A RouteRule for /coming_soon/ is configured for the
 error code 404.

    If the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect.

    When used in conjunction withpathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client.

    defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

#default_custom_error_response_policy=

def default_custom_error_response_policy=(value) -> ::Google::Cloud::Compute::V1::CustomErrorResponsePolicy
Parameter
  • value (::Google::Cloud::Compute::V1::CustomErrorResponsePolicy) — defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error.

    This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels likeRouteRule and PathRule within thisPathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect.

    For example, consider a UrlMap with the following configuration:

     - UrlMap.defaultCustomErrorResponsePolicy is configured
 with policies for 5xx and 4xx errors
 - A RouteRule for /coming_soon/ is configured for the
 error code 404.

    If the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect.

    When used in conjunction withpathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client.

    defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

Returns
  • (::Google::Cloud::Compute::V1::CustomErrorResponsePolicy) — defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error.

    This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels likeRouteRule and PathRule within thisPathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect.

    For example, consider a UrlMap with the following configuration:

     - UrlMap.defaultCustomErrorResponsePolicy is configured
 with policies for 5xx and 4xx errors
 - A RouteRule for /coming_soon/ is configured for the
 error code 404.

    If the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect.

    When used in conjunction withpathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client.

    defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

#default_route_action

def default_route_action() -> ::Google::Cloud::Compute::V1::HttpRouteAction
Returns
  • (::Google::Cloud::Compute::V1::HttpRouteAction) — defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher'sdefaultRouteAction.

#default_route_action=

def default_route_action=(value) -> ::Google::Cloud::Compute::V1::HttpRouteAction
Parameter
  • value (::Google::Cloud::Compute::V1::HttpRouteAction) — defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher'sdefaultRouteAction.

Returns
  • (::Google::Cloud::Compute::V1::HttpRouteAction) — defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher'sdefaultRouteAction.

#default_service

def default_service() -> ::String
Returns
  • (::String) —

    The full or partial URL to the BackendService resource. This URL is used if none of the pathRules orrouteRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

     - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
 - compute/v1/projects/project/global/backendServices/backendService
 - global/backendServices/backendService

    If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

      - compute.backendBuckets.use
  - compute.backendServices.use

#default_service=

def default_service=(value) -> ::String
Parameter
  • value (::String) —

    The full or partial URL to the BackendService resource. This URL is used if none of the pathRules orrouteRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

     - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
 - compute/v1/projects/project/global/backendServices/backendService
 - global/backendServices/backendService

    If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

      - compute.backendBuckets.use
  - compute.backendServices.use
Returns
  • (::String) —

    The full or partial URL to the BackendService resource. This URL is used if none of the pathRules orrouteRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

     - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService
 - compute/v1/projects/project/global/backendServices/backendService
 - global/backendServices/backendService

    If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

      - compute.backendBuckets.use
  - compute.backendServices.use

#default_url_redirect

def default_url_redirect() -> ::Google::Cloud::Compute::V1::HttpRedirectAction
Returns
  • (::Google::Cloud::Compute::V1::HttpRedirectAction) — When none of the specified pathRules orrouteRules match, the request is redirected to a URL specified by defaultUrlRedirect.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    Not supported when the URL map is bound to a target gRPC proxy.

#default_url_redirect=

def default_url_redirect=(value) -> ::Google::Cloud::Compute::V1::HttpRedirectAction
Parameter
  • value (::Google::Cloud::Compute::V1::HttpRedirectAction) — When none of the specified pathRules orrouteRules match, the request is redirected to a URL specified by defaultUrlRedirect.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    Not supported when the URL map is bound to a target gRPC proxy.

Returns
  • (::Google::Cloud::Compute::V1::HttpRedirectAction) — When none of the specified pathRules orrouteRules match, the request is redirected to a URL specified by defaultUrlRedirect.

    Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set.

    Not supported when the URL map is bound to a target gRPC proxy.

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#header_action

def header_action() -> ::Google::Cloud::Compute::V1::HttpHeaderAction
Returns
  • (::Google::Cloud::Compute::V1::HttpHeaderAction) — Specifies changes to request and response headers that need to take effect for the selected backend service.

    HeaderAction specified here are applied after the matchingHttpRouteRule HeaderAction and before theHeaderAction in the UrlMap

    HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL.

    Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

#header_action=

def header_action=(value) -> ::Google::Cloud::Compute::V1::HttpHeaderAction
Parameter
  • value (::Google::Cloud::Compute::V1::HttpHeaderAction) — Specifies changes to request and response headers that need to take effect for the selected backend service.

    HeaderAction specified here are applied after the matchingHttpRouteRule HeaderAction and before theHeaderAction in the UrlMap

    HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL.

    Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Returns
  • (::Google::Cloud::Compute::V1::HttpHeaderAction) — Specifies changes to request and response headers that need to take effect for the selected backend service.

    HeaderAction specified here are applied after the matchingHttpRouteRule HeaderAction and before theHeaderAction in the UrlMap

    HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL.

    Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

#name

def name() -> ::String
Returns
  • (::String) — The name to which this PathMatcher is referred by theHostRule.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The name to which this PathMatcher is referred by theHostRule.
Returns
  • (::String) — The name to which this PathMatcher is referred by theHostRule.

#path_rules

def path_rules() -> ::Array<::Google::Cloud::Compute::V1::PathRule>
Returns
  • (::Array<::Google::Cloud::Compute::V1::PathRule>) — The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. A path rule can only include a wildcard character (*) after a forward slash character ("/").

    The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

    For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

    Within a given pathMatcher, only one ofpathRules or routeRules must be set.

#path_rules=

def path_rules=(value) -> ::Array<::Google::Cloud::Compute::V1::PathRule>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::PathRule>) — The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. A path rule can only include a wildcard character (*) after a forward slash character ("/").

    The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

    For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

    Within a given pathMatcher, only one ofpathRules or routeRules must be set.

Returns
  • (::Array<::Google::Cloud::Compute::V1::PathRule>) — The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. A path rule can only include a wildcard character (*) after a forward slash character ("/").

    The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

    For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

    Within a given pathMatcher, only one ofpathRules or routeRules must be set.

#route_rules

def route_rules() -> ::Array<::Google::Cloud::Compute::V1::HttpRouteRule>
Returns
  • (::Array<::Google::Cloud::Compute::V1::HttpRouteRule>) — The list of HTTP route rules. Use this list instead ofpathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

    Within a given pathMatcher, you can set only one ofpathRules or routeRules.

#route_rules=

def route_rules=(value) -> ::Array<::Google::Cloud::Compute::V1::HttpRouteRule>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::HttpRouteRule>) — The list of HTTP route rules. Use this list instead ofpathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

    Within a given pathMatcher, you can set only one ofpathRules or routeRules.

Returns
  • (::Array<::Google::Cloud::Compute::V1::HttpRouteRule>) — The list of HTTP route rules. Use this list instead ofpathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

    Within a given pathMatcher, you can set only one ofpathRules or routeRules.