Class RouteAction.UpgradeConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.RouteAction.UpgradeConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteAction.UpgradeConfigOrBuilder, Serializable
Enclosing class:
RouteAction
public static final class RouteAction.UpgradeConfig extends com.google.protobuf.GeneratedMessage implements RouteAction.UpgradeConfigOrBuilder
Allows enabling and disabling upgrades on a per-route basis.
This overrides any enabled/disabled upgrade filter chain specified in the
HttpConnectionManager
:ref:`upgrade_configs
<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.upgrade_configs>`
but does not affect any custom filter chain specified there.
Protobuf type envoy.config.route.v3.RouteAction.UpgradeConfig
See Also:

  • Field Details

  • Constructor Details

    • UpgradeConfig

      private UpgradeConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • UpgradeConfig

      private UpgradeConfig()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getUpgradeType

      public String getUpgradeType()
      The case-insensitive name of this upgrade, e.g. "websocket".
For each upgrade type present in upgrade_configs, requests with
Upgrade: [upgrade_type] will be proxied upstream.
      string upgrade_type = 1 [(.validate.rules) = { ... }
      Specified by:
      getUpgradeType in interface RouteAction.UpgradeConfigOrBuilder
      Returns:
      The upgradeType.

    • getUpgradeTypeBytes

      public com.google.protobuf.ByteString getUpgradeTypeBytes()
      The case-insensitive name of this upgrade, e.g. "websocket".
For each upgrade type present in upgrade_configs, requests with
Upgrade: [upgrade_type] will be proxied upstream.
      string upgrade_type = 1 [(.validate.rules) = { ... }
      Specified by:
      getUpgradeTypeBytes in interface RouteAction.UpgradeConfigOrBuilder
      Returns:
      The bytes for upgradeType.

    • hasEnabled

      public boolean hasEnabled()
      Determines if upgrades are available on this route. Defaults to true.
      .google.protobuf.BoolValue enabled = 2;
      Specified by:
      hasEnabled in interface RouteAction.UpgradeConfigOrBuilder
      Returns:
      Whether the enabled field is set.

    • getEnabled

      public com.google.protobuf.BoolValue getEnabled()
      Determines if upgrades are available on this route. Defaults to true.
      .google.protobuf.BoolValue enabled = 2;
      Specified by:
      getEnabled in interface RouteAction.UpgradeConfigOrBuilder
      Returns:
      The enabled.

    • getEnabledOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getEnabledOrBuilder()
      Determines if upgrades are available on this route. Defaults to true.
      .google.protobuf.BoolValue enabled = 2;
      Specified by:
      getEnabledOrBuilder in interface RouteAction.UpgradeConfigOrBuilder

    • hasConnectConfig

      public boolean hasConnectConfig()
      Configuration for sending data upstream as a raw data payload. This is used for
CONNECT requests, when forwarding CONNECT payload as raw TCP.
Note that CONNECT support is currently considered alpha in Envoy.
[#comment: TODO(htuch): Replace the above comment with an alpha tag.]
      .envoy.config.route.v3.RouteAction.UpgradeConfig.ConnectConfig connect_config = 3;
      Specified by:
      hasConnectConfig in interface RouteAction.UpgradeConfigOrBuilder
      Returns:
      Whether the connectConfig field is set.

    • getConnectConfig

      public RouteAction.UpgradeConfig.ConnectConfig getConnectConfig()
      Configuration for sending data upstream as a raw data payload. This is used for
CONNECT requests, when forwarding CONNECT payload as raw TCP.
Note that CONNECT support is currently considered alpha in Envoy.
[#comment: TODO(htuch): Replace the above comment with an alpha tag.]
      .envoy.config.route.v3.RouteAction.UpgradeConfig.ConnectConfig connect_config = 3;
      Specified by:
      getConnectConfig in interface RouteAction.UpgradeConfigOrBuilder
      Returns:
      The connectConfig.

    • getConnectConfigOrBuilder

      public RouteAction.UpgradeConfig.ConnectConfigOrBuilder getConnectConfigOrBuilder()
      Configuration for sending data upstream as a raw data payload. This is used for
CONNECT requests, when forwarding CONNECT payload as raw TCP.
Note that CONNECT support is currently considered alpha in Envoy.
[#comment: TODO(htuch): Replace the above comment with an alpha tag.]
      .envoy.config.route.v3.RouteAction.UpgradeConfig.ConnectConfig connect_config = 3;
      Specified by:
      getConnectConfigOrBuilder in interface RouteAction.UpgradeConfigOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 RouteAction.UpgradeConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RouteAction.UpgradeConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RouteAction.UpgradeConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RouteAction.UpgradeConfig.Builder newBuilder()

    • newBuilder

      public static RouteAction.UpgradeConfig.Builder newBuilder(RouteAction.UpgradeConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected RouteAction.UpgradeConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RouteAction.UpgradeConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RouteAction.UpgradeConfig> 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.GeneratedMessage

    • getDefaultInstanceForType

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