public final class PathRule extends GeneratedMessageV3 implements PathRuleOrBuilder
A path-matching rule for a URL. If matched, will use the specifiedBackendService to handle the traffic arriving at this URL.
Protobuf type google.cloud.compute.v1.PathRule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CUSTOM_ERROR_RESPONSE_POLICY_FIELD_NUMBER
public static final int CUSTOM_ERROR_RESPONSE_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PATHS_FIELD_NUMBER
public static final int PATHS_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 PathRule getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PathRule.Builder newBuilder()
newBuilder(PathRule prototype)
public static PathRule.Builder newBuilder(PathRule prototype)
| Parameter |
| Name |
Description |
prototype |
PathRule
|
public static PathRule parseDelimitedFrom(InputStream input)
public static PathRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PathRule parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PathRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PathRule parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PathRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PathRule parseFrom(CodedInputStream input)
public static PathRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PathRule parseFrom(InputStream input)
public static PathRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PathRule parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PathRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PathRule> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCustomErrorResponsePolicy()
public CustomErrorResponsePolicy getCustomErrorResponsePolicy()
customErrorResponsePolicy specifies how the Load
Balancer returns error responses when BackendServiceorBackendBucket responds with an error.
If a policy for an
error code is not configured for the PathRule, a policy for
the error code configured inpathMatcher.defaultCustomErrorResponsePolicy is applied. If
one is not specified inpathMatcher.defaultCustomErrorResponsePolicy, the policy
configured in UrlMap.defaultCustomErrorResponsePolicy takes
effect.
For example, consider a UrlMap with the following configuration:
- UrlMap.defaultCustomErrorResponsePolicy are configured
with policies for 5xx and 4xx errors
- A PathRule for /coming_soon/ is configured for the error
code 404.
If the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy
takes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404,
the policy in PathRule.customErrorResponsePolicy takes
effect. If any of the requests in this example encounter a 500
error code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect.
customErrorResponsePolicy is supported only for
global external Application Load Balancers.
optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619;
getCustomErrorResponsePolicyOrBuilder()
public CustomErrorResponsePolicyOrBuilder getCustomErrorResponsePolicyOrBuilder()
customErrorResponsePolicy specifies how the Load
Balancer returns error responses when BackendServiceorBackendBucket responds with an error.
If a policy for an
error code is not configured for the PathRule, a policy for
the error code configured inpathMatcher.defaultCustomErrorResponsePolicy is applied. If
one is not specified inpathMatcher.defaultCustomErrorResponsePolicy, the policy
configured in UrlMap.defaultCustomErrorResponsePolicy takes
effect.
For example, consider a UrlMap with the following configuration:
- UrlMap.defaultCustomErrorResponsePolicy are configured
with policies for 5xx and 4xx errors
- A PathRule for /coming_soon/ is configured for the error
code 404.
If the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy
takes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404,
the policy in PathRule.customErrorResponsePolicy takes
effect. If any of the requests in this example encounter a 500
error code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect.
customErrorResponsePolicy is supported only for
global external Application Load Balancers.
optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619;
getDefaultInstanceForType()
public PathRule getDefaultInstanceForType()
getParserForType()
public Parser<PathRule> getParserForType()
Overrides
getPaths(int index)
public String getPaths(int index)
The list of path patterns to match. Each must start with /
and the only place a * is allowed is at the end following
a /. The string fed to the path matcher does not include
any text after the first ? or #, and
those chars are not allowed here.
repeated string paths = 106438894;
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The paths at the given index.
|
getPathsBytes(int index)
public ByteString getPathsBytes(int index)
The list of path patterns to match. Each must start with /
and the only place a * is allowed is at the end following
a /. The string fed to the path matcher does not include
any text after the first ? or #, and
those chars are not allowed here.
repeated string paths = 106438894;
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the paths at the given index.
|
getPathsCount()
public int getPathsCount()
The list of path patterns to match. Each must start with /
and the only place a * is allowed is at the end following
a /. The string fed to the path matcher does not include
any text after the first ? or #, and
those chars are not allowed here.
repeated string paths = 106438894;
| Returns |
| Type |
Description |
int |
The count of paths.
|
getPathsList()
public ProtocolStringList getPathsList()
The list of path patterns to match. Each must start with /
and the only place a * is allowed is at the end following
a /. The string fed to the path matcher does not include
any text after the first ? or #, and
those chars are not allowed here.
repeated string paths = 106438894;
getRouteAction()
public HttpRouteAction getRouteAction()
In response to a matching path, the load balancer
performs advanced routing actions, such as URL rewrites and header
transformations, before forwarding the request to the selected
backend.
Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
URL maps for classic Application Load Balancers only support
the urlRewrite action within a path rule'srouteAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
getRouteActionOrBuilder()
public HttpRouteActionOrBuilder getRouteActionOrBuilder()
In response to a matching path, the load balancer
performs advanced routing actions, such as URL rewrites and header
transformations, before forwarding the request to the selected
backend.
Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
URL maps for classic Application Load Balancers only support
the urlRewrite action within a path rule'srouteAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
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.
Only one of urlRedirect, service orrouteAction.weightedBackendService can 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.
Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
optional string service = 373540533;
| Returns |
| Type |
Description |
ByteString |
The bytes for service.
|
getUrlRedirect()
public HttpRedirectAction getUrlRedirect()
When a path pattern is matched, the request is redirected to a URL
specified by urlRedirect.
Only one of urlRedirect, service orrouteAction.weightedBackendService can 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()
public HttpRedirectActionOrBuilder getUrlRedirectOrBuilder()
When a path pattern is matched, the request is redirected to a URL
specified by urlRedirect.
Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
Not supported when the URL map is bound to a target gRPC proxy.
optional .google.cloud.compute.v1.HttpRedirectAction url_redirect = 405147820;
hasCustomErrorResponsePolicy()
public boolean hasCustomErrorResponsePolicy()
customErrorResponsePolicy specifies how the Load
Balancer returns error responses when BackendServiceorBackendBucket responds with an error.
If a policy for an
error code is not configured for the PathRule, a policy for
the error code configured inpathMatcher.defaultCustomErrorResponsePolicy is applied. If
one is not specified inpathMatcher.defaultCustomErrorResponsePolicy, the policy
configured in UrlMap.defaultCustomErrorResponsePolicy takes
effect.
For example, consider a UrlMap with the following configuration:
- UrlMap.defaultCustomErrorResponsePolicy are configured
with policies for 5xx and 4xx errors
- A PathRule for /coming_soon/ is configured for the error
code 404.
If the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy
takes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404,
the policy in PathRule.customErrorResponsePolicy takes
effect. If any of the requests in this example encounter a 500
error code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect.
customErrorResponsePolicy is supported only for
global external Application Load Balancers.
optional .google.cloud.compute.v1.CustomErrorResponsePolicy custom_error_response_policy = 202816619;
| Returns |
| Type |
Description |
boolean |
Whether the customErrorResponsePolicy field is set.
|
hasRouteAction()
public boolean hasRouteAction()
In response to a matching path, the load balancer
performs advanced routing actions, such as URL rewrites and header
transformations, before forwarding the request to the selected
backend.
Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
URL maps for classic Application Load Balancers only support
the urlRewrite action within a path rule'srouteAction.
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.
Only one of urlRedirect, service orrouteAction.weightedBackendService can be set.
optional string service = 373540533;
| Returns |
| Type |
Description |
boolean |
Whether the service field is set.
|
hasUrlRedirect()
public boolean hasUrlRedirect()
When a path pattern is matched, the request is redirected to a URL
specified by urlRedirect.
Only one of urlRedirect, service orrouteAction.weightedBackendService can 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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PathRule.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PathRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PathRule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
