Interface HttpRouteRuleMatchOrBuilder (1.38.0)

Version 1.38.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface HttpRouteRuleMatchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFullPathMatch()

public abstract String getFullPathMatch()

For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch 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 or regexMatch must be specified.

optional string full_path_match = 214598875;

Returns
Type	Description
String	The fullPathMatch.

getFullPathMatchBytes()

public abstract ByteString getFullPathMatchBytes()

For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch 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 or regexMatch must be specified.

optional string full_path_match = 214598875;

Returns
Type	Description
ByteString	The bytes for fullPathMatch.

getHeaderMatches(int index)

public abstract HttpHeaderMatch getHeaderMatches(int index)

Specifies a list of header match criteria, all of which must match corresponding headers in the request.

repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

Parameter
Name	Description
index	int

Returns
Type	Description
HttpHeaderMatch

getHeaderMatchesCount()

public abstract int getHeaderMatchesCount()

Specifies a list of header match criteria, all of which must match corresponding headers in the request.

repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

Returns
Type	Description
int

getHeaderMatchesList()

public abstract List<HttpHeaderMatch> getHeaderMatchesList()

Specifies a list of header match criteria, all of which must match corresponding headers in the request.

repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

Returns
Type	Description
List<HttpHeaderMatch>

getHeaderMatchesOrBuilder(int index)

public abstract HttpHeaderMatchOrBuilder getHeaderMatchesOrBuilder(int index)

Specifies a list of header match criteria, all of which must match corresponding headers in the request.

repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

Parameter
Name	Description
index	int

Returns
Type	Description
HttpHeaderMatchOrBuilder

getHeaderMatchesOrBuilderList()

public abstract List<? extends HttpHeaderMatchOrBuilder> getHeaderMatchesOrBuilderList()

Specifies a list of header match criteria, all of which must match corresponding headers in the request.

repeated .google.cloud.compute.v1.HttpHeaderMatch header_matches = 361903489;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.HttpHeaderMatchOrBuilder>

getIgnoreCase()

public abstract boolean getIgnoreCase()

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.

optional bool ignore_case = 464324989;

Returns
Type	Description
boolean	The ignoreCase.

getMetadataFilters(int index)

public abstract MetadataFilter getMetadataFilters(int index)

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 its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels 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 the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Parameter
Name	Description
index	int

Returns
Type	Description
MetadataFilter

getMetadataFiltersCount()

public abstract int getMetadataFiltersCount()

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 its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels 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 the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Returns
Type	Description
int

getMetadataFiltersList()

public abstract List<MetadataFilter> getMetadataFiltersList()

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 its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels 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 the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Returns
Type	Description
List<MetadataFilter>

getMetadataFiltersOrBuilder(int index)

public abstract MetadataFilterOrBuilder getMetadataFiltersOrBuilder(int index)

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 its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels 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 the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Parameter
Name	Description
index	int

Returns
Type	Description
MetadataFilterOrBuilder

getMetadataFiltersOrBuilderList()

public abstract List<? extends MetadataFilterOrBuilder> getMetadataFiltersOrBuilderList()

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 its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels 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 the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.MetadataFilter metadata_filters = 464725739;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.MetadataFilterOrBuilder>

getPathTemplateMatch()

public abstract String getPathTemplateMatch()

If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash ("/") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.

optional string path_template_match = 292348186;

Returns
Type	Description
String	The pathTemplateMatch.

getPathTemplateMatchBytes()

public abstract ByteString getPathTemplateMatchBytes()

If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash ("/") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.

optional string path_template_match = 292348186;

Returns
Type	Description
ByteString	The bytes for pathTemplateMatch.

getPrefixMatch()

public abstract String getPrefixMatch()

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. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

optional string prefix_match = 257898968;

Returns
Type	Description
String	The prefixMatch.

getPrefixMatchBytes()

public abstract ByteString getPrefixMatchBytes()

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. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

optional string prefix_match = 257898968;

Returns
Type	Description
ByteString	The bytes for prefixMatch.

getQueryParameterMatches(int index)

public abstract HttpQueryParameterMatch getQueryParameterMatches(int index)

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.

repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

Parameter
Name	Description
index	int

Returns
Type	Description
HttpQueryParameterMatch

getQueryParameterMatchesCount()

public abstract int getQueryParameterMatchesCount()

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.

repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

Returns
Type	Description
int

getQueryParameterMatchesList()

public abstract List<HttpQueryParameterMatch> getQueryParameterMatchesList()

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.

repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

Returns
Type	Description
List<HttpQueryParameterMatch>

getQueryParameterMatchesOrBuilder(int index)

public abstract HttpQueryParameterMatchOrBuilder getQueryParameterMatchesOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

Parameter
Name	Description
index	int

Returns
Type	Description
HttpQueryParameterMatchOrBuilder

getQueryParameterMatchesOrBuilderList()

public abstract List<? extends HttpQueryParameterMatchOrBuilder> getQueryParameterMatchesOrBuilderList()

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.

repeated .google.cloud.compute.v1.HttpQueryParameterMatch query_parameter_matches = 286231270;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.HttpQueryParameterMatchOrBuilder>

getRegexMatch()

public abstract String getRegexMatch()

For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch 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 or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

optional string regex_match = 107387853;

Returns
Type	Description
String	The regexMatch.

getRegexMatchBytes()

public abstract ByteString getRegexMatchBytes()

For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch 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 or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

optional string regex_match = 107387853;

Returns
Type	Description
ByteString	The bytes for regexMatch.

hasFullPathMatch()

public abstract boolean hasFullPathMatch()

For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch 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 or regexMatch must be specified.

optional string full_path_match = 214598875;

Returns
Type	Description
boolean	Whether the fullPathMatch field is set.

hasIgnoreCase()

public abstract boolean hasIgnoreCase()

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.

optional bool ignore_case = 464324989;

Returns
Type	Description
boolean	Whether the ignoreCase field is set.

hasPathTemplateMatch()

public abstract boolean hasPathTemplateMatch()

If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash ("/") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.

optional string path_template_match = 292348186;

Returns
Type	Description
boolean	Whether the pathTemplateMatch field is set.

hasPrefixMatch()

public abstract boolean hasPrefixMatch()

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. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

optional string prefix_match = 257898968;

Returns
Type	Description
boolean	Whether the prefixMatch field is set.

hasRegexMatch()

public abstract boolean hasRegexMatch()

For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch 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 or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

optional string regex_match = 107387853;

Returns
Type	Description
boolean	Whether the regexMatch field is set.