Class HttpRouteRule (1.53.0)

public final class HttpRouteRule extends GeneratedMessageV3 implements HttpRouteRuleOrBuilder

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

Protobuf type google.cloud.compute.v1.HttpRouteRule

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

HEADER_ACTION_FIELD_NUMBER

public static final int HEADER_ACTION_FIELD_NUMBER
Field Value
Type Description
int

MATCH_RULES_FIELD_NUMBER

public static final int MATCH_RULES_FIELD_NUMBER
Field Value
Type Description
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
Type Description
int

ROUTE_ACTION_FIELD_NUMBER

public static final int ROUTE_ACTION_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
Type Description
int

URL_REDIRECT_FIELD_NUMBER

public static final int URL_REDIRECT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HttpRouteRule getDefaultInstance()
Returns
Type Description
HttpRouteRule

getDescriptor()

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

newBuilder()

public static HttpRouteRule.Builder newBuilder()
Returns
Type Description
HttpRouteRule.Builder

newBuilder(HttpRouteRule prototype)

public static HttpRouteRule.Builder newBuilder(HttpRouteRule prototype)
Parameter
Name Description
prototype HttpRouteRule
Returns
Type Description
HttpRouteRule.Builder

parseDelimitedFrom(InputStream input)

public static HttpRouteRule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRouteRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HttpRouteRule parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpRouteRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpRouteRule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpRouteRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpRouteRule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRouteRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HttpRouteRule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRouteRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HttpRouteRule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpRouteRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRouteRule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HttpRouteRule> parser()
Returns
Type Description
Parser<HttpRouteRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public HttpRouteRule getDefaultInstanceForType()
Returns
Type Description
HttpRouteRule

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

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.

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

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>

getParserForType()

public Parser<HttpRouteRule> getParserForType()
Returns
Type Description
Parser<HttpRouteRule>
Overrides

getPriority()

public int getPriority()

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

optional int32 priority = 445151652;

Returns
Type Description
int

The priority.

getRouteAction()

public HttpRouteAction getRouteAction()

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

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

Returns
Type Description
HttpRouteAction

The routeAction.

getRouteActionOrBuilder()

public HttpRouteActionOrBuilder getRouteActionOrBuilder()

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

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

Returns
Type Description
HttpRouteActionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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 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.

getUrlRedirectOrBuilder()

public HttpRedirectActionOrBuilder getUrlRedirectOrBuilder()

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

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

Returns
Type Description
HttpRedirectActionOrBuilder

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasHeaderAction()

public boolean hasHeaderAction()

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

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

Returns
Type Description
boolean

Whether the headerAction field is set.

hasPriority()

public boolean hasPriority()

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

optional int32 priority = 445151652;

Returns
Type Description
boolean

Whether the priority field is set.

hasRouteAction()

public boolean hasRouteAction()

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

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

Returns
Type Description
boolean

Whether the routeAction field is set.

hasService()

public boolean hasService()

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

optional string service = 373540533;

Returns
Type Description
boolean

Whether the service field is set.

hasUrlRedirect()

public boolean hasUrlRedirect()

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

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

Returns
Type Description
boolean

Whether the urlRedirect field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HttpRouteRule.Builder newBuilderForType()
Returns
Type Description
HttpRouteRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRouteRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HttpRouteRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HttpRouteRule.Builder toBuilder()
Returns
Type Description
HttpRouteRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException