Package io.envoyproxy.envoy.extensions.path.rewrite.uri_template.v3

Class UriTemplateRewriteConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.path.rewrite.uri_template.v3.UriTemplateRewriteConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UriTemplateRewriteConfigOrBuilder, Serializable
public final class UriTemplateRewriteConfig extends com.google.protobuf.GeneratedMessageV3 implements UriTemplateRewriteConfigOrBuilder
 Indicates that during forwarding, portions of the path that match the
 pattern should be rewritten, even allowing the substitution of variables
 from the match pattern into the new path as specified by the rewrite template.
 This is useful to allow application paths to be
 rewritten in a way that is aware of segments with variable content like
 identifiers. The router filter will place the original path as it was
 before the rewrite into the :ref:`x-envoy-original-path
 <config_http_filters_router_x-envoy-original-path>` header.

 Only one of :ref:`prefix_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`,
 :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`,
 or *path_template_rewrite* may be specified.

 Template pattern matching types:

 * ``*`` : Matches a single path component, up to the next path separator: /

 * ``**`` : Matches zero or more path segments. If present, must be the last operator.

 * ``{name} or {name=*}`` :  A named variable matching one path segment up to the next path separator: /.

 * ``{name=videos/*}`` : A named variable matching more than one path segment.
      The path component matching videos/* is captured as the named variable.

 * ``{name=**}`` : A named variable matching zero or more path segments.

 Only named matches can be used to perform rewrites.

 Examples using path_template_rewrite:

 * The pattern ``/{one}/{two}`` paired with a substitution string of ``/{two}/{one}`` would
   transform ``/cat/dog`` into ``/dog/cat``.

 * The pattern ``/videos/{language=lang/*}/*`` paired with a substitution string of
   ``/{language}`` would transform ``/videos/lang/en/video.m4s`` into ``lang/en``.

 * The path pattern ``/content/{format}/{lang}/{id}/{file}.vtt`` paired with a substitution
   string of ``/{lang}/{format}/{file}.vtt`` would transform ``/content/hls/en-us/12345/en_193913.vtt``
   into ``/en-us/hls/en_193913.vtt``.
Protobuf type envoy.extensions.path.rewrite.uri_template.v3.UriTemplateRewriteConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    UriTemplateRewriteConfig.Builder
    Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PATH_TEMPLATE_REWRITE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static UriTemplateRewriteConfig
    getDefaultInstance()
     
    UriTemplateRewriteConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<UriTemplateRewriteConfig>
    getParserForType()
     
    String
    getPathTemplateRewrite()
    string path_template_rewrite = 1 [(.validate.rules) = { ... }
    com.google.protobuf.ByteString
    getPathTemplateRewriteBytes()
    string path_template_rewrite = 1 [(.validate.rules) = { ... }
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static UriTemplateRewriteConfig.Builder
    newBuilder()
     
    static UriTemplateRewriteConfig.Builder
    newBuilder(UriTemplateRewriteConfig prototype)
     
    UriTemplateRewriteConfig.Builder
    newBuilderForType()
     
    protected UriTemplateRewriteConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static UriTemplateRewriteConfig
    parseDelimitedFrom(InputStream input)
     
    static UriTemplateRewriteConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UriTemplateRewriteConfig
    parseFrom(byte[] data)
     
    static UriTemplateRewriteConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UriTemplateRewriteConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static UriTemplateRewriteConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UriTemplateRewriteConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static UriTemplateRewriteConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UriTemplateRewriteConfig
    parseFrom(InputStream input)
     
    static UriTemplateRewriteConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UriTemplateRewriteConfig
    parseFrom(ByteBuffer data)
     
    static UriTemplateRewriteConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<UriTemplateRewriteConfig>
    parser()
     
    UriTemplateRewriteConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • PATH_TEMPLATE_REWRITE_FIELD_NUMBER

      public static final int PATH_TEMPLATE_REWRITE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getPathTemplateRewrite

      public String getPathTemplateRewrite()
      string path_template_rewrite = 1 [(.validate.rules) = { ... }
      Specified by:
      getPathTemplateRewrite in interface UriTemplateRewriteConfigOrBuilder
      Returns:
      The pathTemplateRewrite.

    • getPathTemplateRewriteBytes

      public com.google.protobuf.ByteString getPathTemplateRewriteBytes()
      string path_template_rewrite = 1 [(.validate.rules) = { ... }
      Specified by:
      getPathTemplateRewriteBytes in interface UriTemplateRewriteConfigOrBuilder
      Returns:
      The bytes for pathTemplateRewrite.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UriTemplateRewriteConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UriTemplateRewriteConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UriTemplateRewriteConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UriTemplateRewriteConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UriTemplateRewriteConfig.Builder newBuilder()

    • newBuilder

      public static UriTemplateRewriteConfig.Builder newBuilder(UriTemplateRewriteConfig prototype)

    • toBuilder

      public UriTemplateRewriteConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UriTemplateRewriteConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static UriTemplateRewriteConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UriTemplateRewriteConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<UriTemplateRewriteConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public UriTemplateRewriteConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder