Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::HttpRouteRuleMatch.
HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#full_path_match
def full_path_match() -> ::String-
(::String) — For satisfying the matchRule condition, the path of the
request must exactly match the value specified infullPathMatch after removing any query parameters and anchor
that may be part of the original URL.
fullPathMatch must be from 1 to 1024 characters.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match must be specified.
#full_path_match=
def full_path_match=(value) -> ::String-
value (::String) — For satisfying the matchRule condition, the path of the
request must exactly match the value specified infullPathMatch after removing any query parameters and anchor
that may be part of the original URL.
fullPathMatch must be from 1 to 1024 characters.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match must be specified.
-
(::String) — For satisfying the matchRule condition, the path of the
request must exactly match the value specified infullPathMatch after removing any query parameters and anchor
that may be part of the original URL.
fullPathMatch must be from 1 to 1024 characters.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match must be specified.
#header_matches
def header_matches() -> ::Array<::Google::Cloud::Compute::V1::HttpHeaderMatch>- (::Array<::Google::Cloud::Compute::V1::HttpHeaderMatch>) — Specifies a list of header match criteria, all of which must match corresponding headers in the request.
#header_matches=
def header_matches=(value) -> ::Array<::Google::Cloud::Compute::V1::HttpHeaderMatch>- value (::Array<::Google::Cloud::Compute::V1::HttpHeaderMatch>) — Specifies a list of header match criteria, all of which must match corresponding headers in the request.
- (::Array<::Google::Cloud::Compute::V1::HttpHeaderMatch>) — Specifies a list of header match criteria, all of which must match corresponding headers in the request.
#ignore_case
def ignore_case() -> ::Boolean-
(::Boolean) — Specifies that prefixMatch and fullPathMatch
matches are case sensitive.
The default value is false.
ignoreCase must not be used with regexMatch.
Not supported when the URL map is bound to a target gRPC proxy.
#ignore_case=
def ignore_case=(value) -> ::Boolean-
value (::Boolean) — Specifies that prefixMatch and fullPathMatch
matches are case sensitive.
The default value is false.
ignoreCase must not be used with regexMatch.
Not supported when the URL map is bound to a target gRPC proxy.
-
(::Boolean) — Specifies that prefixMatch and fullPathMatch
matches are case sensitive.
The default value is false.
ignoreCase must not be used with regexMatch.
Not supported when the URL map is bound to a target gRPC proxy.
#metadata_filters
def metadata_filters() -> ::Array<::Google::Cloud::Compute::V1::MetadataFilter>-
(::Array<::Google::Cloud::Compute::V1::MetadataFilter>) — Opaque filter criteria used by the load balancer to restrict routing
configuration to a limited set of xDS
compliant clients. In their xDS requests to the load balancer, xDS clients
present node
metadata. When there is a match, the relevant routing configuration
is made available to those proxies.
For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match.
metadataFilters specified here is applied after those specified in ForwardingRule that refers to theUrlMap this HttpRouteRuleMatch belongs to.
metadataFilters only applies to load balancers that haveloadBalancingScheme set toINTERNAL_SELF_MANAGED.
Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
#metadata_filters=
def metadata_filters=(value) -> ::Array<::Google::Cloud::Compute::V1::MetadataFilter>-
value (::Array<::Google::Cloud::Compute::V1::MetadataFilter>) — Opaque filter criteria used by the load balancer to restrict routing
configuration to a limited set of xDS
compliant clients. In their xDS requests to the load balancer, xDS clients
present node
metadata. When there is a match, the relevant routing configuration
is made available to those proxies.
For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match.
metadataFilters specified here is applied after those specified in ForwardingRule that refers to theUrlMap this HttpRouteRuleMatch belongs to.
metadataFilters only applies to load balancers that haveloadBalancingScheme set toINTERNAL_SELF_MANAGED.
Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
-
(::Array<::Google::Cloud::Compute::V1::MetadataFilter>) — Opaque filter criteria used by the load balancer to restrict routing
configuration to a limited set of xDS
compliant clients. In their xDS requests to the load balancer, xDS clients
present node
metadata. When there is a match, the relevant routing configuration
is made available to those proxies.
For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match.
metadataFilters specified here is applied after those specified in ForwardingRule that refers to theUrlMap this HttpRouteRuleMatch belongs to.
metadataFilters only applies to load balancers that haveloadBalancingScheme set toINTERNAL_SELF_MANAGED.
Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
#path_template_match
def path_template_match() -> ::String-
(::String) — If specified, this field defines a path template pattern that must match
the :path header after the query string is removed.
A path template pattern can include variables and wildcards. Variables are enclosed in curly braces, for example{variable_name}. Wildcards include * that matches a single path segment, and ** that matches zero or more path segments. The pattern must follow these rules:
- The value must be between 1 and 1024 characters. - The pattern must start with a leading slash ("/"). - No more than 5 operators (variables or wildcards) may appear in the pattern.Precisely one ofprefixMatch, fullPathMatch,regexMatch, or pathTemplateMatch must be set.
#path_template_match=
def path_template_match=(value) -> ::String-
value (::String) — If specified, this field defines a path template pattern that must match
the :path header after the query string is removed.
A path template pattern can include variables and wildcards. Variables are enclosed in curly braces, for example{variable_name}. Wildcards include * that matches a single path segment, and ** that matches zero or more path segments. The pattern must follow these rules:
- The value must be between 1 and 1024 characters. - The pattern must start with a leading slash ("/"). - No more than 5 operators (variables or wildcards) may appear in the pattern.Precisely one ofprefixMatch, fullPathMatch,regexMatch, or pathTemplateMatch must be set.
-
(::String) — If specified, this field defines a path template pattern that must match
the :path header after the query string is removed.
A path template pattern can include variables and wildcards. Variables are enclosed in curly braces, for example{variable_name}. Wildcards include * that matches a single path segment, and ** that matches zero or more path segments. The pattern must follow these rules:
- The value must be between 1 and 1024 characters. - The pattern must start with a leading slash ("/"). - No more than 5 operators (variables or wildcards) may appear in the pattern.Precisely one ofprefixMatch, fullPathMatch,regexMatch, or pathTemplateMatch must be set.
#prefix_match
def prefix_match() -> ::String-
(::String) — For satisfying the matchRule condition, the request's
path must begin with the specified prefixMatch.prefixMatch must begin with a /.
The value must be from 1 to 1024 characters.
The * character inside a prefix match is treated as a literal character, not as a wildcard.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match can be used within a matchRule.
#prefix_match=
def prefix_match=(value) -> ::String-
value (::String) — For satisfying the matchRule condition, the request's
path must begin with the specified prefixMatch.prefixMatch must begin with a /.
The value must be from 1 to 1024 characters.
The * character inside a prefix match is treated as a literal character, not as a wildcard.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match can be used within a matchRule.
-
(::String) — For satisfying the matchRule condition, the request's
path must begin with the specified prefixMatch.prefixMatch must begin with a /.
The value must be from 1 to 1024 characters.
The * character inside a prefix match is treated as a literal character, not as a wildcard.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match can be used within a matchRule.
#query_parameter_matches
def query_parameter_matches() -> ::Array<::Google::Cloud::Compute::V1::HttpQueryParameterMatch>-
(::Array<::Google::Cloud::Compute::V1::HttpQueryParameterMatch>) — Specifies a list of query parameter match criteria, all of which must
match corresponding query parameters in the request.
Not supported when the URL map is bound to a target gRPC proxy.
#query_parameter_matches=
def query_parameter_matches=(value) -> ::Array<::Google::Cloud::Compute::V1::HttpQueryParameterMatch>-
value (::Array<::Google::Cloud::Compute::V1::HttpQueryParameterMatch>) — Specifies a list of query parameter match criteria, all of which must
match corresponding query parameters in the request.
Not supported when the URL map is bound to a target gRPC proxy.
-
(::Array<::Google::Cloud::Compute::V1::HttpQueryParameterMatch>) — Specifies a list of query parameter match criteria, all of which must
match corresponding query parameters in the request.
Not supported when the URL map is bound to a target gRPC proxy.
#regex_match
def regex_match() -> ::String-
(::String) — For satisfying the matchRule condition, the path of the
request must satisfy the regular expression specified inregexMatch after removing any query parameters and anchor
supplied with the original URL. For
more information about regular expression syntax, see Syntax.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match must be specified.
Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED, EXTERNAL_MANAGED (regional scope) or INTERNAL_MANAGED.
#regex_match=
def regex_match=(value) -> ::String-
value (::String) — For satisfying the matchRule condition, the path of the
request must satisfy the regular expression specified inregexMatch after removing any query parameters and anchor
supplied with the original URL. For
more information about regular expression syntax, see Syntax.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match must be specified.
Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED, EXTERNAL_MANAGED (regional scope) or INTERNAL_MANAGED.
-
(::String) — For satisfying the matchRule condition, the path of the
request must satisfy the regular expression specified inregexMatch after removing any query parameters and anchor
supplied with the original URL. For
more information about regular expression syntax, see Syntax.
Only one of prefixMatch, fullPathMatch,regexMatch or path_template_match must be specified.
Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED, EXTERNAL_MANAGED (regional scope) or INTERNAL_MANAGED.