Class HttpRouteRule.Builder (1.57.0)

public static final class HttpRouteRule.Builder extends GeneratedMessageV3.Builder<HttpRouteRule.Builder> implements HttpRouteRuleOrBuilder

The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.

Protobuf type google.cloud.compute.v1.HttpRouteRule

Static Methods

getDescriptor()

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

Methods

addAllMatchRules(Iterable<? extends HttpRouteRuleMatch> values)

public HttpRouteRule.Builder addAllMatchRules(Iterable<? extends HttpRouteRuleMatch> values)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.HttpRouteRuleMatch>
Returns
Type Description
HttpRouteRule.Builder

addMatchRules(HttpRouteRuleMatch value)

public HttpRouteRule.Builder addMatchRules(HttpRouteRuleMatch value)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Parameter
Name Description
value HttpRouteRuleMatch
Returns
Type Description
HttpRouteRule.Builder

addMatchRules(HttpRouteRuleMatch.Builder builderForValue)

public HttpRouteRule.Builder addMatchRules(HttpRouteRuleMatch.Builder builderForValue)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Parameter
Name Description
builderForValue HttpRouteRuleMatch.Builder
Returns
Type Description
HttpRouteRule.Builder

addMatchRules(int index, HttpRouteRuleMatch value)

public HttpRouteRule.Builder addMatchRules(int index, HttpRouteRuleMatch value)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

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

addMatchRules(int index, HttpRouteRuleMatch.Builder builderForValue)

public HttpRouteRule.Builder addMatchRules(int index, HttpRouteRuleMatch.Builder builderForValue)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

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

addMatchRulesBuilder()

public HttpRouteRuleMatch.Builder addMatchRulesBuilder()

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Returns
Type Description
HttpRouteRuleMatch.Builder

addMatchRulesBuilder(int index)

public HttpRouteRuleMatch.Builder addMatchRulesBuilder(int index)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Parameter
Name Description
index int
Returns
Type Description
HttpRouteRuleMatch.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public HttpRouteRule build()
Returns
Type Description
HttpRouteRule

buildPartial()

public HttpRouteRule buildPartial()
Returns
Type Description
HttpRouteRule

clear()

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

clearDescription()

public HttpRouteRule.Builder clearDescription()

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

optional string description = 422937596;

Returns
Type Description
HttpRouteRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearHeaderAction()

public HttpRouteRule.Builder clearHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpRouteRule.Builder

clearMatchRules()

public HttpRouteRule.Builder clearMatchRules()

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Returns
Type Description
HttpRouteRule.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPriority()

public HttpRouteRule.Builder clearPriority()

For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

optional int32 priority = 445151652;

Returns
Type Description
HttpRouteRule.Builder

This builder for chaining.

clearRouteAction()

public HttpRouteRule.Builder clearRouteAction()

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.

optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

Returns
Type Description
HttpRouteRule.Builder

clearService()

public HttpRouteRule.Builder clearService()

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

optional string service = 373540533;

Returns
Type Description
HttpRouteRule.Builder

This builder for chaining.

clearUrlRedirect()

public HttpRouteRule.Builder clearUrlRedirect()

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

Returns
Type Description
HttpRouteRule.Builder

clone()

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

getDefaultInstanceForType()

public HttpRouteRule getDefaultInstanceForType()
Returns
Type Description
HttpRouteRule

getDescription()

public String getDescription()

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getHeaderAction()

public HttpHeaderAction getHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpHeaderAction

The headerAction.

getHeaderActionBuilder()

public HttpHeaderAction.Builder getHeaderActionBuilder()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpHeaderAction.Builder

getHeaderActionOrBuilder()

public HttpHeaderActionOrBuilder getHeaderActionOrBuilder()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpHeaderActionOrBuilder

getMatchRules(int index)

public HttpRouteRuleMatch getMatchRules(int index)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Parameter
Name Description
index int
Returns
Type Description
HttpRouteRuleMatch

getMatchRulesBuilder(int index)

public HttpRouteRuleMatch.Builder getMatchRulesBuilder(int index)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Parameter
Name Description
index int
Returns
Type Description
HttpRouteRuleMatch.Builder

getMatchRulesBuilderList()

public List<HttpRouteRuleMatch.Builder> getMatchRulesBuilderList()

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Returns
Type Description
List<Builder>

getMatchRulesCount()

public int getMatchRulesCount()

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Returns
Type Description
int

getMatchRulesList()

public List<HttpRouteRuleMatch> getMatchRulesList()

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Returns
Type Description
List<HttpRouteRuleMatch>

getMatchRulesOrBuilder(int index)

public HttpRouteRuleMatchOrBuilder getMatchRulesOrBuilder(int index)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Parameter
Name Description
index int
Returns
Type Description
HttpRouteRuleMatchOrBuilder

getMatchRulesOrBuilderList()

public List<? extends HttpRouteRuleMatchOrBuilder> getMatchRulesOrBuilderList()

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

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

getPriority()

public int getPriority()

For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

optional int32 priority = 445151652;

Returns
Type Description
int

The priority.

getRouteAction()

public HttpRouteAction getRouteAction()

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.

optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

Returns
Type Description
HttpRouteAction

The routeAction.

getRouteActionBuilder()

public HttpRouteAction.Builder getRouteActionBuilder()

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.

optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

Returns
Type Description
HttpRouteAction.Builder

getRouteActionOrBuilder()

public HttpRouteActionOrBuilder getRouteActionOrBuilder()

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.

optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

Returns
Type Description
HttpRouteActionOrBuilder

getService()

public String getService()

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

optional string service = 373540533;

Returns
Type Description
String

The service.

getServiceBytes()

public ByteString getServiceBytes()

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

optional string service = 373540533;

Returns
Type Description
ByteString

The bytes for service.

getUrlRedirect()

public HttpRedirectAction getUrlRedirect()

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

Returns
Type Description
HttpRedirectAction

The urlRedirect.

getUrlRedirectBuilder()

public HttpRedirectAction.Builder getUrlRedirectBuilder()

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

Returns
Type Description
HttpRedirectAction.Builder

getUrlRedirectOrBuilder()

public HttpRedirectActionOrBuilder getUrlRedirectOrBuilder()

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

Returns
Type Description
HttpRedirectActionOrBuilder

hasDescription()

public boolean hasDescription()

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasHeaderAction()

public boolean hasHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
boolean

Whether the headerAction field is set.

hasPriority()

public boolean hasPriority()

For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

optional int32 priority = 445151652;

Returns
Type Description
boolean

Whether the priority field is set.

hasRouteAction()

public boolean hasRouteAction()

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.

optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

Returns
Type Description
boolean

Whether the routeAction field is set.

hasService()

public boolean hasService()

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

optional string service = 373540533;

Returns
Type Description
boolean

Whether the service field is set.

hasUrlRedirect()

public boolean hasUrlRedirect()

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

Returns
Type Description
boolean

Whether the urlRedirect field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(HttpRouteRule other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeHeaderAction(HttpHeaderAction value)

public HttpRouteRule.Builder mergeHeaderAction(HttpHeaderAction value)

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Parameter
Name Description
value HttpHeaderAction
Returns
Type Description
HttpRouteRule.Builder

mergeRouteAction(HttpRouteAction value)

public HttpRouteRule.Builder mergeRouteAction(HttpRouteAction value)

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.

optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

Parameter
Name Description
value HttpRouteAction
Returns
Type Description
HttpRouteRule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUrlRedirect(HttpRedirectAction value)

public HttpRouteRule.Builder mergeUrlRedirect(HttpRedirectAction value)

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

Parameter
Name Description
value HttpRedirectAction
Returns
Type Description
HttpRouteRule.Builder

removeMatchRules(int index)

public HttpRouteRule.Builder removeMatchRules(int index)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

Parameter
Name Description
index int
Returns
Type Description
HttpRouteRule.Builder

setDescription(String value)

public HttpRouteRule.Builder setDescription(String value)

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
HttpRouteRule.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public HttpRouteRule.Builder setDescriptionBytes(ByteString value)

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
HttpRouteRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setHeaderAction(HttpHeaderAction value)

public HttpRouteRule.Builder setHeaderAction(HttpHeaderAction value)

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Parameter
Name Description
value HttpHeaderAction
Returns
Type Description
HttpRouteRule.Builder

setHeaderAction(HttpHeaderAction.Builder builderForValue)

public HttpRouteRule.Builder setHeaderAction(HttpHeaderAction.Builder builderForValue)

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Parameter
Name Description
builderForValue HttpHeaderAction.Builder
Returns
Type Description
HttpRouteRule.Builder

setMatchRules(int index, HttpRouteRuleMatch value)

public HttpRouteRule.Builder setMatchRules(int index, HttpRouteRuleMatch value)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

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

setMatchRules(int index, HttpRouteRuleMatch.Builder builderForValue)

public HttpRouteRule.Builder setMatchRules(int index, HttpRouteRuleMatch.Builder builderForValue)

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

repeated .google.cloud.compute.v1.HttpRouteRuleMatch match_rules = 376200701;

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

setPriority(int value)

public HttpRouteRule.Builder setPriority(int value)

For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

optional int32 priority = 445151652;

Parameter
Name Description
value int

The priority to set.

Returns
Type Description
HttpRouteRule.Builder

This builder for chaining.

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

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

setRouteAction(HttpRouteAction value)

public HttpRouteRule.Builder setRouteAction(HttpRouteAction value)

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.

optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

Parameter
Name Description
value HttpRouteAction
Returns
Type Description
HttpRouteRule.Builder

setRouteAction(HttpRouteAction.Builder builderForValue)

public HttpRouteRule.Builder setRouteAction(HttpRouteAction.Builder builderForValue)

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.

optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;

Parameter
Name Description
builderForValue HttpRouteAction.Builder
Returns
Type Description
HttpRouteRule.Builder

setService(String value)

public HttpRouteRule.Builder setService(String value)

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

optional string service = 373540533;

Parameter
Name Description
value String

The service to set.

Returns
Type Description
HttpRouteRule.Builder

This builder for chaining.

setServiceBytes(ByteString value)

public HttpRouteRule.Builder setServiceBytes(ByteString value)

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

optional string service = 373540533;

Parameter
Name Description
value ByteString

The bytes for service to set.

Returns
Type Description
HttpRouteRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUrlRedirect(HttpRedirectAction value)

public HttpRouteRule.Builder setUrlRedirect(HttpRedirectAction value)

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

Parameter
Name Description
value HttpRedirectAction
Returns
Type Description
HttpRouteRule.Builder

setUrlRedirect(HttpRedirectAction.Builder builderForValue)

public HttpRouteRule.Builder setUrlRedirect(HttpRedirectAction.Builder builderForValue)

When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;

Parameter
Name Description
builderForValue HttpRedirectAction.Builder
Returns
Type Description
HttpRouteRule.Builder