Class HttpRouteRule.Builder (1.12.0)

Version 1.12.0

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

public 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HttpRouteRule.Builder

Implements

HttpRouteRuleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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. UrlMaps for external HTTP(S) load balancers support only 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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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. UrlMaps for external HTTP(S) load balancers support only 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. UrlMaps for external HTTP(S) load balancers support only 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. UrlMaps for external HTTP(S) load balancers support only 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. UrlMaps for external HTTP(S) load balancers support only 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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public HttpRouteRule.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
HttpRouteRule.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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. UrlMaps for external HTTP(S) load balancers support only 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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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. UrlMaps for external HTTP(S) load balancers support only 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. UrlMaps for external HTTP(S) load balancers support only 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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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