Class HttpRouteRule.Builder (1.7.2)

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

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

Protobuf type google.cloud.compute.v1.HttpRouteRule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.HttpRouteRuleMatch>
Returns
TypeDescription
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
NameDescription
valueHttpRouteRuleMatch
Returns
TypeDescription
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
NameDescription
builderForValueHttpRouteRuleMatch.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueHttpRouteRuleMatch
Returns
TypeDescription
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
NameDescription
indexint
builderForValueHttpRouteRuleMatch.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
HttpRouteRuleMatch.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HttpRouteRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
HttpRouteRule.Builder
Overrides

build()

public HttpRouteRule build()
Returns
TypeDescription
HttpRouteRule

buildPartial()

public HttpRouteRule buildPartial()
Returns
TypeDescription
HttpRouteRule

clear()

public HttpRouteRule.Builder clear()
Returns
TypeDescription
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
TypeDescription
HttpRouteRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public HttpRouteRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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 specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

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

Returns
TypeDescription
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
TypeDescription
HttpRouteRule.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public HttpRouteRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
HttpRouteRule.Builder
Overrides

clearPriority()

public HttpRouteRule.Builder clearPriority()

For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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
TypeDescription
HttpRouteRule.Builder

This builder for chaining.

clearRouteAction()

public HttpRouteRule.Builder clearRouteAction()

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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 routeRule's routeAction.

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

Returns
TypeDescription
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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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
TypeDescription
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 target gRPC proxy.

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

Returns
TypeDescription
HttpRouteRule.Builder

clone()

public HttpRouteRule.Builder clone()
Returns
TypeDescription
HttpRouteRule.Builder
Overrides

getDefaultInstanceForType()

public HttpRouteRule getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHeaderAction()

public HttpHeaderAction getHeaderAction()

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

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

Returns
TypeDescription
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 specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

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

Returns
TypeDescription
HttpHeaderAction.Builder

getHeaderActionOrBuilder()

public HttpHeaderActionOrBuilder getHeaderActionOrBuilder()

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

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.compute.v1.HttpRouteRuleMatchOrBuilder>

getPriority()

public int getPriority()

For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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
TypeDescription
int

The priority.

getRouteAction()

public HttpRouteAction getRouteAction()

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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 routeRule's routeAction.

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

Returns
TypeDescription
HttpRouteAction

The routeAction.

getRouteActionBuilder()

public HttpRouteAction.Builder getRouteActionBuilder()

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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 routeRule's routeAction.

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

Returns
TypeDescription
HttpRouteAction.Builder

getRouteActionOrBuilder()

public HttpRouteActionOrBuilder getRouteActionOrBuilder()

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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 routeRule's routeAction.

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

Returns
TypeDescription
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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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
TypeDescription
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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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
TypeDescription
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 target gRPC proxy.

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

Returns
TypeDescription
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 target gRPC proxy.

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

Returns
TypeDescription
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 target gRPC proxy.

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

Returns
TypeDescription
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
TypeDescription
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 specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

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

Returns
TypeDescription
boolean

Whether the headerAction field is set.

hasPriority()

public boolean hasPriority()

For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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
TypeDescription
boolean

Whether the priority field is set.

hasRouteAction()

public boolean hasRouteAction()

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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 routeRule's routeAction.

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

Returns
TypeDescription
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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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
TypeDescription
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 target gRPC proxy.

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

Returns
TypeDescription
boolean

Whether the urlRedirect field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(HttpRouteRule other)

public HttpRouteRule.Builder mergeFrom(HttpRouteRule other)
Parameter
NameDescription
otherHttpRouteRule
Returns
TypeDescription
HttpRouteRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HttpRouteRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HttpRouteRule.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public HttpRouteRule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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 specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

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

Parameter
NameDescription
valueHttpHeaderAction
Returns
TypeDescription
HttpRouteRule.Builder

mergeRouteAction(HttpRouteAction value)

public HttpRouteRule.Builder mergeRouteAction(HttpRouteAction value)

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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 routeRule's routeAction.

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

Parameter
NameDescription
valueHttpRouteAction
Returns
TypeDescription
HttpRouteRule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HttpRouteRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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 target gRPC proxy.

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

Parameter
NameDescription
valueHttpRedirectAction
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueString

The description to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
HttpRouteRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public HttpRouteRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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 specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

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

Parameter
NameDescription
valueHttpHeaderAction
Returns
TypeDescription
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 specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

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

Parameter
NameDescription
builderForValueHttpHeaderAction.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueHttpRouteRuleMatch
Returns
TypeDescription
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
NameDescription
indexint
builderForValueHttpRouteRuleMatch.Builder
Returns
TypeDescription
HttpRouteRule.Builder

setPriority(int value)

public HttpRouteRule.Builder setPriority(int value)

For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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
NameDescription
valueint

The priority to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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 like URL rewrites, header transformations, etc. prior to 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 routeRule's routeAction.

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

Parameter
NameDescription
valueHttpRouteAction
Returns
TypeDescription
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 like URL rewrites, header transformations, etc. prior to 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 routeRule's routeAction.

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

Parameter
NameDescription
builderForValueHttpRouteAction.Builder
Returns
TypeDescription
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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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
NameDescription
valueString

The service to set.

Returns
TypeDescription
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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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
NameDescription
valueByteString

The bytes for service to set.

Returns
TypeDescription
HttpRouteRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final HttpRouteRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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 target gRPC proxy.

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

Parameter
NameDescription
valueHttpRedirectAction
Returns
TypeDescription
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 target gRPC proxy.

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

Parameter
NameDescription
builderForValueHttpRedirectAction.Builder
Returns
TypeDescription
HttpRouteRule.Builder