Package io.envoyproxy.envoy.extensions.filters.network.generic_proxy.router.v3

Class Router.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>
io.envoyproxy.envoy.extensions.filters.network.generic_proxy.router.v3.Router.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouterOrBuilder, Cloneable
Enclosing class:
Router
public static final class Router.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder> implements RouterOrBuilder
Protobuf type envoy.extensions.filters.network.generic_proxy.router.v3.Router

  • Method Summary

    Modifier and Type
    Method
    Description
    Router.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    Router
    build()
     
    Router
    buildPartial()
     
    Router.Builder
    clear()
     
    Router.Builder
    clearBindUpstreamConnection()
    Set to true if the upstream connection should be bound to the downstream connection, false otherwise.
    Router.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    Router.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    Router.Builder
    clone()
     
    boolean
    getBindUpstreamConnection()
    Set to true if the upstream connection should be bound to the downstream connection, false otherwise.
    Router
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Router.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Router.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Router.Builder
    mergeFrom(Router other)
     
    final Router.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    Router.Builder
    setBindUpstreamConnection(boolean value)
    Set to true if the upstream connection should be bound to the downstream connection, false otherwise.
    Router.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    Router.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    final Router.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

    getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • 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.Builder<Router.Builder>

    • clear

      public Router.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • getDefaultInstanceForType

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

    • build

      public Router build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Router buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public Router.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • setField

      public Router.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • clearField

      public Router.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • clearOneof

      public Router.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • setRepeatedField

      public Router.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • addRepeatedField

      public Router.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • mergeFrom

      public Router.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Router.Builder>

    • mergeFrom

      public Router.Builder mergeFrom(Router other)

    • isInitialized

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

    • mergeFrom

      public Router.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Router.Builder>
      Throws:
      IOException

    • getBindUpstreamConnection

      public boolean getBindUpstreamConnection()
       Set to true if the upstream connection should be bound to the downstream connection, false
 otherwise.

 By default, one random upstream connection will be selected from the upstream connection pool
 and used for every request. And after the request is finished, the upstream connection will be
 released back to the upstream connection pool.

 If this option is true, the upstream connection will be bound to the downstream connection and
 have same lifetime as the downstream connection. The same upstream connection will be used for
 all requests from the same downstream connection.

 And if this options is true, one of the following requirements must be met:

 1. The request must be handled one by one. That is, the next request can not be sent to the
    upstream until the previous request is finished.
 2. Unique request id must be provided for each request and response. The request id must be
    unique for each request and response pair in same connection pair. And the request id must
    be the same for the corresponding request and response.

 This could be useful for some protocols that require the same upstream connection to be used
 for all requests from the same downstream connection. For example, the protocol using stateful
 connection.
      bool bind_upstream_connection = 1;
      Specified by:
      getBindUpstreamConnection in interface RouterOrBuilder
      Returns:
      The bindUpstreamConnection.

    • setBindUpstreamConnection

      public Router.Builder setBindUpstreamConnection(boolean value)
       Set to true if the upstream connection should be bound to the downstream connection, false
 otherwise.

 By default, one random upstream connection will be selected from the upstream connection pool
 and used for every request. And after the request is finished, the upstream connection will be
 released back to the upstream connection pool.

 If this option is true, the upstream connection will be bound to the downstream connection and
 have same lifetime as the downstream connection. The same upstream connection will be used for
 all requests from the same downstream connection.

 And if this options is true, one of the following requirements must be met:

 1. The request must be handled one by one. That is, the next request can not be sent to the
    upstream until the previous request is finished.
 2. Unique request id must be provided for each request and response. The request id must be
    unique for each request and response pair in same connection pair. And the request id must
    be the same for the corresponding request and response.

 This could be useful for some protocols that require the same upstream connection to be used
 for all requests from the same downstream connection. For example, the protocol using stateful
 connection.
      bool bind_upstream_connection = 1;
      Parameters:
      value - The bindUpstreamConnection to set.
      Returns:
      This builder for chaining.

    • clearBindUpstreamConnection

      public Router.Builder clearBindUpstreamConnection()
       Set to true if the upstream connection should be bound to the downstream connection, false
 otherwise.

 By default, one random upstream connection will be selected from the upstream connection pool
 and used for every request. And after the request is finished, the upstream connection will be
 released back to the upstream connection pool.

 If this option is true, the upstream connection will be bound to the downstream connection and
 have same lifetime as the downstream connection. The same upstream connection will be used for
 all requests from the same downstream connection.

 And if this options is true, one of the following requirements must be met:

 1. The request must be handled one by one. That is, the next request can not be sent to the
    upstream until the previous request is finished.
 2. Unique request id must be provided for each request and response. The request id must be
    unique for each request and response pair in same connection pair. And the request id must
    be the same for the corresponding request and response.

 This could be useful for some protocols that require the same upstream connection to be used
 for all requests from the same downstream connection. For example, the protocol using stateful
 connection.
      bool bind_upstream_connection = 1;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Router.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>

    • mergeUnknownFields

      public final Router.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Router.Builder>