public final class HttpRouteRule extends GeneratedMessageV3 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 Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
public static final int HEADER_ACTION_FIELD_NUMBER
Field Value
MATCH_RULES_FIELD_NUMBER
public static final int MATCH_RULES_FIELD_NUMBER
Field Value
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
Field Value
ROUTE_ACTION_FIELD_NUMBER
public static final int ROUTE_ACTION_FIELD_NUMBER
Field Value
SERVICE_FIELD_NUMBER
public static final int SERVICE_FIELD_NUMBER
Field Value
URL_REDIRECT_FIELD_NUMBER
public static final int URL_REDIRECT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static HttpRouteRule getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static HttpRouteRule.Builder newBuilder()
Returns
newBuilder(HttpRouteRule prototype)
public static HttpRouteRule.Builder newBuilder(HttpRouteRule prototype)
Parameter
Returns
public static HttpRouteRule parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static HttpRouteRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static HttpRouteRule parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpRouteRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static HttpRouteRule parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRouteRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HttpRouteRule parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static HttpRouteRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static HttpRouteRule parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static HttpRouteRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static HttpRouteRule parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpRouteRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<HttpRouteRule> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public HttpRouteRule getDefaultInstanceForType()
Returns
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;
| 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;
| Type | Description |
| ByteString | The bytes for description.
|
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;
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;
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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.cloud.compute.v1.HttpRouteRuleMatchOrBuilder> | |
getParserForType()
public Parser<HttpRouteRule> getParserForType()
Returns
Overrides
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;
| Type | Description |
| 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;
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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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;
| 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 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
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;
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;
| Type | Description |
| boolean | Whether the description field is set.
|
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;
| 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 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;
| 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 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;
| 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 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;
| 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 target gRPC proxy.
optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;
| Type | Description |
| boolean | Whether the urlRedirect field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public HttpRouteRule.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpRouteRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public HttpRouteRule.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
