Class HttpRouteRuleMatch.Builder (1.65.0)

public static final class HttpRouteRuleMatch.Builder extends GeneratedMessageV3.Builder<HttpRouteRuleMatch.Builder> implements HttpRouteRuleMatchOrBuilder

HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

Protobuf type google.cloud.compute.v1.HttpRouteRuleMatch

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllHeaderMatches(Iterable<? extends HttpHeaderMatch> values)

public HttpRouteRuleMatch.Builder addAllHeaderMatches(Iterable<? extends HttpHeaderMatch> values)

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
values Iterable<? extends com.google.cloud.compute.v1.HttpHeaderMatch>
Returns
Type Description
HttpRouteRuleMatch.Builder

addAllMetadataFilters(Iterable<? extends MetadataFilter> values)

public HttpRouteRuleMatch.Builder addAllMetadataFilters(Iterable<? extends MetadataFilter> values)

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
values Iterable<? extends com.google.cloud.compute.v1.MetadataFilter>
Returns
Type Description
HttpRouteRuleMatch.Builder

addAllQueryParameterMatches(Iterable<? extends HttpQueryParameterMatch> values)

public HttpRouteRuleMatch.Builder addAllQueryParameterMatches(Iterable<? extends HttpQueryParameterMatch> values)

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
values Iterable<? extends com.google.cloud.compute.v1.HttpQueryParameterMatch>
Returns
Type Description
HttpRouteRuleMatch.Builder

addHeaderMatches(HttpHeaderMatch value)

public HttpRouteRuleMatch.Builder addHeaderMatches(HttpHeaderMatch value)

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
value HttpHeaderMatch
Returns
Type Description
HttpRouteRuleMatch.Builder

addHeaderMatches(HttpHeaderMatch.Builder builderForValue)

public HttpRouteRuleMatch.Builder addHeaderMatches(HttpHeaderMatch.Builder builderForValue)

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
builderForValue HttpHeaderMatch.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

addHeaderMatches(int index, HttpHeaderMatch value)

public HttpRouteRuleMatch.Builder addHeaderMatches(int index, HttpHeaderMatch value)

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;

Parameters
Name Description
index int
value HttpHeaderMatch
Returns
Type Description
HttpRouteRuleMatch.Builder

addHeaderMatches(int index, HttpHeaderMatch.Builder builderForValue)

public HttpRouteRuleMatch.Builder addHeaderMatches(int index, HttpHeaderMatch.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue HttpHeaderMatch.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

addHeaderMatchesBuilder()

public HttpHeaderMatch.Builder addHeaderMatchesBuilder()

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
HttpHeaderMatch.Builder

addHeaderMatchesBuilder(int index)

public HttpHeaderMatch.Builder addHeaderMatchesBuilder(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.Builder

addMetadataFilters(MetadataFilter value)

public HttpRouteRuleMatch.Builder addMetadataFilters(MetadataFilter value)

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
value MetadataFilter
Returns
Type Description
HttpRouteRuleMatch.Builder

addMetadataFilters(MetadataFilter.Builder builderForValue)

public HttpRouteRuleMatch.Builder addMetadataFilters(MetadataFilter.Builder builderForValue)

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
builderForValue MetadataFilter.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

addMetadataFilters(int index, MetadataFilter value)

public HttpRouteRuleMatch.Builder addMetadataFilters(int index, MetadataFilter value)

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;

Parameters
Name Description
index int
value MetadataFilter
Returns
Type Description
HttpRouteRuleMatch.Builder

addMetadataFilters(int index, MetadataFilter.Builder builderForValue)

public HttpRouteRuleMatch.Builder addMetadataFilters(int index, MetadataFilter.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue MetadataFilter.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

addMetadataFiltersBuilder()

public MetadataFilter.Builder addMetadataFiltersBuilder()

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
MetadataFilter.Builder

addMetadataFiltersBuilder(int index)

public MetadataFilter.Builder addMetadataFiltersBuilder(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.Builder

addQueryParameterMatches(HttpQueryParameterMatch value)

public HttpRouteRuleMatch.Builder addQueryParameterMatches(HttpQueryParameterMatch value)

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
value HttpQueryParameterMatch
Returns
Type Description
HttpRouteRuleMatch.Builder

addQueryParameterMatches(HttpQueryParameterMatch.Builder builderForValue)

public HttpRouteRuleMatch.Builder addQueryParameterMatches(HttpQueryParameterMatch.Builder builderForValue)

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
builderForValue HttpQueryParameterMatch.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

addQueryParameterMatches(int index, HttpQueryParameterMatch value)

public HttpRouteRuleMatch.Builder addQueryParameterMatches(int index, HttpQueryParameterMatch value)

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;

Parameters
Name Description
index int
value HttpQueryParameterMatch
Returns
Type Description
HttpRouteRuleMatch.Builder

addQueryParameterMatches(int index, HttpQueryParameterMatch.Builder builderForValue)

public HttpRouteRuleMatch.Builder addQueryParameterMatches(int index, HttpQueryParameterMatch.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue HttpQueryParameterMatch.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

addQueryParameterMatchesBuilder()

public HttpQueryParameterMatch.Builder addQueryParameterMatchesBuilder()

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
HttpQueryParameterMatch.Builder

addQueryParameterMatchesBuilder(int index)

public HttpQueryParameterMatch.Builder addQueryParameterMatchesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HttpRouteRuleMatch.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

build()

public HttpRouteRuleMatch build()
Returns
Type Description
HttpRouteRuleMatch

buildPartial()

public HttpRouteRuleMatch buildPartial()
Returns
Type Description
HttpRouteRuleMatch

clear()

public HttpRouteRuleMatch.Builder clear()
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public HttpRouteRuleMatch.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

clearFullPathMatch()

public HttpRouteRuleMatch.Builder clearFullPathMatch()

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
HttpRouteRuleMatch.Builder

This builder for chaining.

clearHeaderMatches()

public HttpRouteRuleMatch.Builder clearHeaderMatches()

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
HttpRouteRuleMatch.Builder

clearIgnoreCase()

public HttpRouteRuleMatch.Builder clearIgnoreCase()

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
HttpRouteRuleMatch.Builder

This builder for chaining.

clearMetadataFilters()

public HttpRouteRuleMatch.Builder clearMetadataFilters()

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
HttpRouteRuleMatch.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public HttpRouteRuleMatch.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

clearPathTemplateMatch()

public HttpRouteRuleMatch.Builder clearPathTemplateMatch()

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
HttpRouteRuleMatch.Builder

This builder for chaining.

clearPrefixMatch()

public HttpRouteRuleMatch.Builder clearPrefixMatch()

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
HttpRouteRuleMatch.Builder

This builder for chaining.

clearQueryParameterMatches()

public HttpRouteRuleMatch.Builder clearQueryParameterMatches()

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
HttpRouteRuleMatch.Builder

clearRegexMatch()

public HttpRouteRuleMatch.Builder clearRegexMatch()

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
HttpRouteRuleMatch.Builder

This builder for chaining.

clone()

public HttpRouteRuleMatch.Builder clone()
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

getDefaultInstanceForType()

public HttpRouteRuleMatch getDefaultInstanceForType()
Returns
Type Description
HttpRouteRuleMatch

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFullPathMatch()

public 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 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 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

getHeaderMatchesBuilder(int index)

public HttpHeaderMatch.Builder getHeaderMatchesBuilder(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.Builder

getHeaderMatchesBuilderList()

public List<HttpHeaderMatch.Builder> getHeaderMatchesBuilderList()

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<Builder>

getHeaderMatchesCount()

public 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 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 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 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 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 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

getMetadataFiltersBuilder(int index)

public MetadataFilter.Builder getMetadataFiltersBuilder(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.Builder

getMetadataFiltersBuilderList()

public List<MetadataFilter.Builder> getMetadataFiltersBuilderList()

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<Builder>

getMetadataFiltersCount()

public 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 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 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 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 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 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 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 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 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

getQueryParameterMatchesBuilder(int index)

public HttpQueryParameterMatch.Builder getQueryParameterMatchesBuilder(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.Builder

getQueryParameterMatchesBuilderList()

public List<HttpQueryParameterMatch.Builder> getQueryParameterMatchesBuilderList()

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<Builder>

getQueryParameterMatchesCount()

public 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 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 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 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 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(HttpRouteRuleMatch other)

public HttpRouteRuleMatch.Builder mergeFrom(HttpRouteRuleMatch other)
Parameter
Name Description
other HttpRouteRuleMatch
Returns
Type Description
HttpRouteRuleMatch.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HttpRouteRuleMatch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HttpRouteRuleMatch.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HttpRouteRuleMatch.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

removeHeaderMatches(int index)

public HttpRouteRuleMatch.Builder removeHeaderMatches(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
HttpRouteRuleMatch.Builder

removeMetadataFilters(int index)

public HttpRouteRuleMatch.Builder removeMetadataFilters(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
HttpRouteRuleMatch.Builder

removeQueryParameterMatches(int index)

public HttpRouteRuleMatch.Builder removeQueryParameterMatches(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
HttpRouteRuleMatch.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public HttpRouteRuleMatch.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

setFullPathMatch(String value)

public HttpRouteRuleMatch.Builder setFullPathMatch(String value)

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;

Parameter
Name Description
value String

The fullPathMatch to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setFullPathMatchBytes(ByteString value)

public HttpRouteRuleMatch.Builder setFullPathMatchBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for fullPathMatch to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setHeaderMatches(int index, HttpHeaderMatch value)

public HttpRouteRuleMatch.Builder setHeaderMatches(int index, HttpHeaderMatch value)

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;

Parameters
Name Description
index int
value HttpHeaderMatch
Returns
Type Description
HttpRouteRuleMatch.Builder

setHeaderMatches(int index, HttpHeaderMatch.Builder builderForValue)

public HttpRouteRuleMatch.Builder setHeaderMatches(int index, HttpHeaderMatch.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue HttpHeaderMatch.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

setIgnoreCase(boolean value)

public HttpRouteRuleMatch.Builder setIgnoreCase(boolean value)

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;

Parameter
Name Description
value boolean

The ignoreCase to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setMetadataFilters(int index, MetadataFilter value)

public HttpRouteRuleMatch.Builder setMetadataFilters(int index, MetadataFilter value)

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;

Parameters
Name Description
index int
value MetadataFilter
Returns
Type Description
HttpRouteRuleMatch.Builder

setMetadataFilters(int index, MetadataFilter.Builder builderForValue)

public HttpRouteRuleMatch.Builder setMetadataFilters(int index, MetadataFilter.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue MetadataFilter.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

setPathTemplateMatch(String value)

public HttpRouteRuleMatch.Builder setPathTemplateMatch(String value)

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;

Parameter
Name Description
value String

The pathTemplateMatch to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setPathTemplateMatchBytes(ByteString value)

public HttpRouteRuleMatch.Builder setPathTemplateMatchBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for pathTemplateMatch to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setPrefixMatch(String value)

public HttpRouteRuleMatch.Builder setPrefixMatch(String value)

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;

Parameter
Name Description
value String

The prefixMatch to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setPrefixMatchBytes(ByteString value)

public HttpRouteRuleMatch.Builder setPrefixMatchBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for prefixMatch to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setQueryParameterMatches(int index, HttpQueryParameterMatch value)

public HttpRouteRuleMatch.Builder setQueryParameterMatches(int index, HttpQueryParameterMatch value)

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;

Parameters
Name Description
index int
value HttpQueryParameterMatch
Returns
Type Description
HttpRouteRuleMatch.Builder

setQueryParameterMatches(int index, HttpQueryParameterMatch.Builder builderForValue)

public HttpRouteRuleMatch.Builder setQueryParameterMatches(int index, HttpQueryParameterMatch.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue HttpQueryParameterMatch.Builder
Returns
Type Description
HttpRouteRuleMatch.Builder

setRegexMatch(String value)

public HttpRouteRuleMatch.Builder setRegexMatch(String value)

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;

Parameter
Name Description
value String

The regexMatch to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setRegexMatchBytes(ByteString value)

public HttpRouteRuleMatch.Builder setRegexMatchBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for regexMatch to set.

Returns
Type Description
HttpRouteRuleMatch.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HttpRouteRuleMatch.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final HttpRouteRuleMatch.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
HttpRouteRuleMatch.Builder
Overrides