public final class PathRule extends GeneratedMessageV3 implements PathRuleOrBuilder
A 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
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
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. 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 external HTTP(S) load balancers only support the urlRewrite action within a path rule's routeAction.
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. 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 external HTTP(S) load balancers only support the urlRewrite action within a path rule's routeAction.
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. 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;
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;
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 external HTTP(S) 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.
|
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)
Overrides
toBuilder()
public PathRule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
