Interface HttpRouteRuleOrBuilder (1.14.0)

Version 1.14.0

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

public interface HttpRouteRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

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

getHeaderAction()

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

getHeaderActionOrBuilder()

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

getMatchRulesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 external HTTP(S) 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.

getRouteActionOrBuilder()

public abstract 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 external HTTP(S) 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 abstract 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 abstract 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 abstract 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.

getUrlRedirectOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 external HTTP(S) 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 abstract 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 abstract 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.