Class PathRule (1.43.0)

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

Implements

PathRuleOrBuilder

Static Fields

PATHS_FIELD_NUMBER

public static final int PATHS_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTE_ACTION_FIELD_NUMBER

public static final int ROUTE_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
TypeDescription
int

URL_REDIRECT_FIELD_NUMBER

public static final int URL_REDIRECT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PathRule getDefaultInstance()
Returns
TypeDescription
PathRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PathRule.Builder newBuilder()
Returns
TypeDescription
PathRule.Builder

newBuilder(PathRule prototype)

public static PathRule.Builder newBuilder(PathRule prototype)
Parameter
NameDescription
prototypePathRule
Returns
TypeDescription
PathRule.Builder

parseDelimitedFrom(InputStream input)

public static PathRule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PathRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PathRule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PathRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PathRule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PathRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PathRule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PathRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PathRule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PathRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PathRule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PathRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PathRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PathRule> parser()
Returns
TypeDescription
Parser<PathRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PathRule getDefaultInstanceForType()
Returns
TypeDescription
PathRule

getParserForType()

public Parser<PathRule> getParserForType()
Returns
TypeDescription
Parser<PathRule>
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
HttpRouteAction

The routeAction.

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
TypeDescription
HttpRouteActionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
HttpRedirectAction

The urlRedirect.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the urlRedirect field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PathRule.Builder newBuilderForType()
Returns
TypeDescription
PathRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PathRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PathRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PathRule.Builder toBuilder()
Returns
TypeDescription
PathRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException