Class UrlRewrite

  • All Implemented Interfaces:
    UrlRewriteOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class UrlRewrite
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UrlRewrite.Builder
      The spec for modifying the path before sending the request to the matched backend service.
      • 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
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static UrlRewrite getDefaultInstance()  
      UrlRewrite getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      String getHostRewrite()
      Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
      com.google.protobuf.ByteString getHostRewriteBytes()
      Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
      com.google.protobuf.Parser<UrlRewrite> getParserForType()  
      String getPathPrefixRewrite()
      Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
      com.google.protobuf.ByteString getPathPrefixRewriteBytes()
      Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
      String getPathTemplateRewrite()
      If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax.
      com.google.protobuf.ByteString getPathTemplateRewriteBytes()
      If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax.
      int getSerializedSize()  
      int hashCode()  
      boolean hasHostRewrite()
      Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
      boolean hasPathPrefixRewrite()
      Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
      boolean hasPathTemplateRewrite()
      If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static UrlRewrite.Builder newBuilder()  
      static UrlRewrite.Builder newBuilder​(UrlRewrite prototype)  
      UrlRewrite.Builder newBuilderForType()  
      protected UrlRewrite.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static UrlRewrite parseDelimitedFrom​(InputStream input)  
      static UrlRewrite parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UrlRewrite parseFrom​(byte[] data)  
      static UrlRewrite parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UrlRewrite parseFrom​(com.google.protobuf.ByteString data)  
      static UrlRewrite parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UrlRewrite parseFrom​(com.google.protobuf.CodedInputStream input)  
      static UrlRewrite parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UrlRewrite parseFrom​(InputStream input)  
      static UrlRewrite parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UrlRewrite parseFrom​(ByteBuffer data)  
      static UrlRewrite parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<UrlRewrite> parser()  
      UrlRewrite.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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 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 Detail

      • HOST_REWRITE_FIELD_NUMBER

        public static final int HOST_REWRITE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PATH_PREFIX_REWRITE_FIELD_NUMBER

        public static final int PATH_PREFIX_REWRITE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PATH_TEMPLATE_REWRITE_FIELD_NUMBER

        public static final int PATH_TEMPLATE_REWRITE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • 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
      • 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;
        Specified by:
        hasHostRewrite in interface UrlRewriteOrBuilder
        Returns:
        Whether the hostRewrite field is set.
      • 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;
        Specified by:
        getHostRewrite in interface UrlRewriteOrBuilder
        Returns:
        The hostRewrite.
      • getHostRewriteBytes

        public com.google.protobuf.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;
        Specified by:
        getHostRewriteBytes in interface UrlRewriteOrBuilder
        Returns:
        The bytes for hostRewrite.
      • 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;
        Specified by:
        hasPathPrefixRewrite in interface UrlRewriteOrBuilder
        Returns:
        Whether the pathPrefixRewrite field is set.
      • 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;
        Specified by:
        getPathPrefixRewrite in interface UrlRewriteOrBuilder
        Returns:
        The pathPrefixRewrite.
      • getPathPrefixRewriteBytes

        public com.google.protobuf.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;
        Specified by:
        getPathPrefixRewriteBytes in interface UrlRewriteOrBuilder
        Returns:
        The bytes for pathPrefixRewrite.
      • 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;
        Specified by:
        hasPathTemplateRewrite in interface UrlRewriteOrBuilder
        Returns:
        Whether the pathTemplateRewrite field is set.
      • 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;
        Specified by:
        getPathTemplateRewrite in interface UrlRewriteOrBuilder
        Returns:
        The pathTemplateRewrite.
      • getPathTemplateRewriteBytes

        public com.google.protobuf.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;
        Specified by:
        getPathTemplateRewriteBytes in interface UrlRewriteOrBuilder
        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 UrlRewrite parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static UrlRewrite parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static UrlRewrite parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected UrlRewrite.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static UrlRewrite getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<UrlRewrite> parser()
      • getParserForType

        public com.google.protobuf.Parser<UrlRewrite> 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 UrlRewrite getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder