- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class PathRule.Builder extends GeneratedMessageV3.Builder<PathRule.Builder> implements PathRuleOrBuilderA path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
Protobuf type google.cloud.compute.v1.PathRule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PathRule.BuilderImplements
PathRuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllPaths(Iterable<String> values)
public PathRule.Builder addAllPaths(Iterable<String> values)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 |
values |
Iterable<String>The paths to add. |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
This builder for chaining. |
addPaths(String value)
public PathRule.Builder addPaths(String value)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 |
value |
StringThe paths to add. |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
This builder for chaining. |
addPathsBytes(ByteString value)
public PathRule.Builder addPathsBytes(ByteString value)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 |
value |
ByteStringThe bytes of the paths to add. |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PathRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
build()
public PathRule build()| Returns | |
|---|---|
| Type | Description |
PathRule |
|
buildPartial()
public PathRule buildPartial()| Returns | |
|---|---|
| Type | Description |
PathRule |
|
clear()
public PathRule.Builder clear()| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public PathRule.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public PathRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
clearPaths()
public PathRule.Builder clearPaths()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 |
PathRule.Builder |
This builder for chaining. |
clearRouteAction()
public PathRule.Builder clearRouteAction()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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
clearService()
public PathRule.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 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 |
PathRule.Builder |
This builder for chaining. |
clearUrlRedirect()
public PathRule.Builder clearUrlRedirect()When a path pattern 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 |
PathRule.Builder |
|
clone()
public PathRule.Builder clone()| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
getDefaultInstanceForType()
public PathRule getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PathRule |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
intThe 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 |
intThe 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the paths. |
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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
| Returns | |
|---|---|
| Type | Description |
HttpRouteAction |
The routeAction. |
getRouteActionBuilder()
public HttpRouteAction.Builder getRouteActionBuilder()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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
| Returns | |
|---|---|
| Type | Description |
HttpRouteAction.Builder |
|
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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
| Returns | |
|---|---|
| Type | Description |
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 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 a path pattern 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. |
getUrlRedirectBuilder()
public HttpRedirectAction.Builder getUrlRedirectBuilder()When a path pattern 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.Builder |
|
getUrlRedirectOrBuilder()
public HttpRedirectActionOrBuilder getUrlRedirectOrBuilder()When a path pattern 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 |
|
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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path 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 a path pattern 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PathRule other)
public PathRule.Builder mergeFrom(PathRule other)| Parameter | |
|---|---|
| Name | Description |
other |
PathRule |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PathRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PathRule.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
mergeRouteAction(HttpRouteAction value)
public PathRule.Builder mergeRouteAction(HttpRouteAction value)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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
| Parameter | |
|---|---|
| Name | Description |
value |
HttpRouteAction |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PathRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
mergeUrlRedirect(HttpRedirectAction value)
public PathRule.Builder mergeUrlRedirect(HttpRedirectAction value)When a path pattern 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;
| Parameter | |
|---|---|
| Name | Description |
value |
HttpRedirectAction |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public PathRule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
setPaths(int index, String value)
public PathRule.Builder setPaths(int index, String value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe paths to set. |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PathRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
setRouteAction(HttpRouteAction value)
public PathRule.Builder setRouteAction(HttpRouteAction value)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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
| Parameter | |
|---|---|
| Name | Description |
value |
HttpRouteAction |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
setRouteAction(HttpRouteAction.Builder builderForValue)
public PathRule.Builder setRouteAction(HttpRouteAction.Builder builderForValue)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. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.
optional .google.cloud.compute.v1.HttpRouteAction route_action = 424563948;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
HttpRouteAction.Builder |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
setService(String value)
public PathRule.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 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe service to set. |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
This builder for chaining. |
setServiceBytes(ByteString value)
public PathRule.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 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for service to set. |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final PathRule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
setUrlRedirect(HttpRedirectAction value)
public PathRule.Builder setUrlRedirect(HttpRedirectAction value)When a path pattern 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;
| Parameter | |
|---|---|
| Name | Description |
value |
HttpRedirectAction |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|
setUrlRedirect(HttpRedirectAction.Builder builderForValue)
public PathRule.Builder setUrlRedirect(HttpRedirectAction.Builder builderForValue)When a path pattern 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
HttpRedirectAction.Builder |
| Returns | |
|---|---|
| Type | Description |
PathRule.Builder |
|