public final class HttpRouteRule extends com.google.protobuf.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| Modifier and Type | Class and Description |
|---|---|
static class |
HttpRouteRule.Builder
The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
HEADER_ACTION_FIELD_NUMBER |
static int |
MATCH_RULES_FIELD_NUMBER |
static int |
PRIORITY_FIELD_NUMBER |
static int |
ROUTE_ACTION_FIELD_NUMBER |
static int |
SERVICE_FIELD_NUMBER |
static int |
URL_REDIRECT_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static HttpRouteRule |
getDefaultInstance() |
HttpRouteRule |
getDefaultInstanceForType() |
String |
getDescription()
The short description conveying the intent of this routeRule.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
The short description conveying the intent of this routeRule.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
HttpHeaderAction |
getHeaderAction()
Specifies changes to request and response headers that need to take effect for the selected backendService.
|
HttpHeaderActionOrBuilder |
getHeaderActionOrBuilder()
Specifies changes to request and response headers that need to take effect for the selected backendService.
|
HttpRouteRuleMatch |
getMatchRules(int index)
The list of criteria for matching attributes of a request to this routeRule.
|
int |
getMatchRulesCount()
The list of criteria for matching attributes of a request to this routeRule.
|
List<HttpRouteRuleMatch> |
getMatchRulesList()
The list of criteria for matching attributes of a request to this routeRule.
|
HttpRouteRuleMatchOrBuilder |
getMatchRulesOrBuilder(int index)
The list of criteria for matching attributes of a request to this routeRule.
|
List<? extends HttpRouteRuleMatchOrBuilder> |
getMatchRulesOrBuilderList()
The list of criteria for matching attributes of a request to this routeRule.
|
com.google.protobuf.Parser<HttpRouteRule> |
getParserForType() |
int |
getPriority()
For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules.
|
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.
|
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.
|
int |
getSerializedSize() |
String |
getService()
The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
|
com.google.protobuf.ByteString |
getServiceBytes()
The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
HttpRedirectAction |
getUrlRedirect()
When this rule is matched, the request is redirected to a URL specified by urlRedirect.
|
HttpRedirectActionOrBuilder |
getUrlRedirectOrBuilder()
When this rule is matched, the request is redirected to a URL specified by urlRedirect.
|
boolean |
hasDescription()
The short description conveying the intent of this routeRule.
|
int |
hashCode() |
boolean |
hasHeaderAction()
Specifies changes to request and response headers that need to take effect for the selected backendService.
|
boolean |
hasPriority()
For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules.
|
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.
|
boolean |
hasService()
The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
|
boolean |
hasUrlRedirect()
When this rule is matched, the request is redirected to a URL specified by urlRedirect.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static HttpRouteRule.Builder |
newBuilder() |
static HttpRouteRule.Builder |
newBuilder(HttpRouteRule prototype) |
HttpRouteRule.Builder |
newBuilderForType() |
protected HttpRouteRule.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static HttpRouteRule |
parseDelimitedFrom(InputStream input) |
static HttpRouteRule |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpRouteRule |
parseFrom(byte[] data) |
static HttpRouteRule |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpRouteRule |
parseFrom(ByteBuffer data) |
static HttpRouteRule |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpRouteRule |
parseFrom(com.google.protobuf.ByteString data) |
static HttpRouteRule |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpRouteRule |
parseFrom(com.google.protobuf.CodedInputStream input) |
static HttpRouteRule |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpRouteRule |
parseFrom(InputStream input) |
static HttpRouteRule |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<HttpRouteRule> |
parser() |
HttpRouteRule.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int DESCRIPTION_FIELD_NUMBER
public static final int HEADER_ACTION_FIELD_NUMBER
public static final int MATCH_RULES_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
public static final int ROUTE_ACTION_FIELD_NUMBER
public static final int SERVICE_FIELD_NUMBER
public static final int URL_REDIRECT_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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;hasDescription in interface HttpRouteRuleOrBuilderpublic 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;getDescription in interface HttpRouteRuleOrBuilderpublic com.google.protobuf.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;getDescriptionBytes in interface HttpRouteRuleOrBuilderpublic 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;hasHeaderAction in interface HttpRouteRuleOrBuilderpublic 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;getHeaderAction in interface HttpRouteRuleOrBuilderpublic 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;getHeaderActionOrBuilder in interface HttpRouteRuleOrBuilderpublic 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;getMatchRulesList in interface HttpRouteRuleOrBuilderpublic 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;getMatchRulesOrBuilderList in interface HttpRouteRuleOrBuilderpublic 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;getMatchRulesCount in interface HttpRouteRuleOrBuilderpublic 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;getMatchRules in interface HttpRouteRuleOrBuilderpublic 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;getMatchRulesOrBuilder in interface HttpRouteRuleOrBuilderpublic 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;hasPriority in interface HttpRouteRuleOrBuilderpublic 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;getPriority in interface HttpRouteRuleOrBuilderpublic boolean hasRouteAction()
In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;hasRouteAction in interface HttpRouteRuleOrBuilderpublic HttpRouteAction getRouteAction()
In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;getRouteAction in interface HttpRouteRuleOrBuilderpublic HttpRouteActionOrBuilder getRouteActionOrBuilder()
In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;getRouteActionOrBuilder in interface HttpRouteRuleOrBuilderpublic 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;hasService in interface HttpRouteRuleOrBuilderpublic 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;getService in interface HttpRouteRuleOrBuilderpublic com.google.protobuf.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;getServiceBytes in interface HttpRouteRuleOrBuilderpublic 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;hasUrlRedirect in interface HttpRouteRuleOrBuilderpublic 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;getUrlRedirect in interface HttpRouteRuleOrBuilderpublic 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;getUrlRedirectOrBuilder in interface HttpRouteRuleOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static HttpRouteRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpRouteRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpRouteRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpRouteRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpRouteRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpRouteRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpRouteRule parseFrom(InputStream input) throws IOException
IOExceptionpublic static HttpRouteRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static HttpRouteRule parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static HttpRouteRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static HttpRouteRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static HttpRouteRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic HttpRouteRule.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static HttpRouteRule.Builder newBuilder()
public static HttpRouteRule.Builder newBuilder(HttpRouteRule prototype)
public HttpRouteRule.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected HttpRouteRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static HttpRouteRule getDefaultInstance()
public static com.google.protobuf.Parser<HttpRouteRule> parser()
public com.google.protobuf.Parser<HttpRouteRule> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public HttpRouteRule getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.