Class UrlRewrite (1.56.0)

public final class UrlRewrite extends GeneratedMessageV3 implements UrlRewriteOrBuilder

The spec for modifying the path before sending the request to the matched backend service.

Protobuf type google.cloud.compute.v1.UrlRewrite

Implements

UrlRewriteOrBuilder

Static Fields

HOST_REWRITE_FIELD_NUMBER

public static final int HOST_REWRITE_FIELD_NUMBER
Field Value
Type Description
int

PATH_PREFIX_REWRITE_FIELD_NUMBER

public static final int PATH_PREFIX_REWRITE_FIELD_NUMBER
Field Value
Type Description
int

PATH_TEMPLATE_REWRITE_FIELD_NUMBER

public static final int PATH_TEMPLATE_REWRITE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UrlRewrite getDefaultInstance()
Returns
Type Description
UrlRewrite

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static UrlRewrite.Builder newBuilder()
Returns
Type Description
UrlRewrite.Builder

newBuilder(UrlRewrite prototype)

public static UrlRewrite.Builder newBuilder(UrlRewrite prototype)
Parameter
Name Description
prototype UrlRewrite
Returns
Type Description
UrlRewrite.Builder

parseDelimitedFrom(InputStream input)

public static UrlRewrite parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UrlRewrite
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlRewrite parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlRewrite
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UrlRewrite parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UrlRewrite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UrlRewrite parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlRewrite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UrlRewrite parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UrlRewrite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UrlRewrite parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlRewrite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UrlRewrite parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UrlRewrite
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlRewrite parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlRewrite
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UrlRewrite parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UrlRewrite
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UrlRewrite parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlRewrite
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UrlRewrite parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UrlRewrite
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UrlRewrite parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlRewrite
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UrlRewrite> parser()
Returns
Type Description
Parser<UrlRewrite>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UrlRewrite getDefaultInstanceForType()
Returns
Type Description
UrlRewrite

getHostRewrite()

public String getHostRewrite()

Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.

optional string host_rewrite = 159819253;

Returns
Type Description
String

The hostRewrite.

getHostRewriteBytes()

public ByteString getHostRewriteBytes()

Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.

optional string host_rewrite = 159819253;

Returns
Type Description
ByteString

The bytes for hostRewrite.

getParserForType()

public Parser<UrlRewrite> getParserForType()
Returns
Type Description
Parser<UrlRewrite>
Overrides

getPathPrefixRewrite()

public String getPathPrefixRewrite()

Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.

optional string path_prefix_rewrite = 41186361;

Returns
Type Description
String

The pathPrefixRewrite.

getPathPrefixRewriteBytes()

public ByteString getPathPrefixRewriteBytes()

Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.

optional string path_prefix_rewrite = 41186361;

Returns
Type Description
ByteString

The bytes for pathPrefixRewrite.

getPathTemplateRewrite()

public String getPathTemplateRewrite()

If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=} or {var=}. For example, a path_template_match of /static/{format=} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=*} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.

optional string path_template_rewrite = 423409569;

Returns
Type Description
String

The pathTemplateRewrite.

getPathTemplateRewriteBytes()

public ByteString getPathTemplateRewriteBytes()

If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=} or {var=}. For example, a path_template_match of /static/{format=} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=*} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.

optional string path_template_rewrite = 423409569;

Returns
Type Description
ByteString

The bytes for pathTemplateRewrite.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasHostRewrite()

public boolean hasHostRewrite()

Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.

optional string host_rewrite = 159819253;

Returns
Type Description
boolean

Whether the hostRewrite field is set.

hasPathPrefixRewrite()

public boolean hasPathPrefixRewrite()

Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.

optional string path_prefix_rewrite = 41186361;

Returns
Type Description
boolean

Whether the pathPrefixRewrite field is set.

hasPathTemplateRewrite()

public boolean hasPathTemplateRewrite()

If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=} or {var=}. For example, a path_template_match of /static/{format=} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=*} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.

optional string path_template_rewrite = 423409569;

Returns
Type Description
boolean

Whether the pathTemplateRewrite field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UrlRewrite.Builder newBuilderForType()
Returns
Type Description
UrlRewrite.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UrlRewrite.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UrlRewrite.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UrlRewrite.Builder toBuilder()
Returns
Type Description
UrlRewrite.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException