Package io.envoyproxy.envoy.config.core.v3

Class AlternateProtocolsCacheOptions.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AlternateProtocolsCacheOptionsOrBuilder, Cloneable
    Enclosing class:
    AlternateProtocolsCacheOptions
    public static final class AlternateProtocolsCacheOptions.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AlternateProtocolsCacheOptions.Builder>
implements AlternateProtocolsCacheOptionsOrBuilder
     Configures the alternate protocols cache which tracks alternate protocols that can be used to
 make an HTTP connection to an origin server. See https://tools.ietf.org/html/rfc7838 for
 HTTP Alternative Services and https://datatracker.ietf.org/doc/html/draft-ietf-dnsop-svcb-https-04
 for the "HTTPS" DNS resource record.
    Protobuf type envoy.config.core.v3.AlternateProtocolsCacheOptions

    • Method Detail

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • getName

        public String getName()
         The name of the cache. Multiple named caches allow independent alternate protocols cache
 configurations to operate within a single Envoy process using different configurations. All
 alternate protocols cache options with the same name *must* be equal in all fields when
 referenced from different configuration components. Configuration will fail to load if this is
 not the case.
        string name = 1 [(.validate.rules) = { ... }
        Specified by:
        getName in interface AlternateProtocolsCacheOptionsOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the cache. Multiple named caches allow independent alternate protocols cache
 configurations to operate within a single Envoy process using different configurations. All
 alternate protocols cache options with the same name *must* be equal in all fields when
 referenced from different configuration components. Configuration will fail to load if this is
 not the case.
        string name = 1 [(.validate.rules) = { ... }
        Specified by:
        getNameBytes in interface AlternateProtocolsCacheOptionsOrBuilder
        Returns:
        The bytes for name.

      • setName

        public AlternateProtocolsCacheOptions.Builder setName​(String value)
         The name of the cache. Multiple named caches allow independent alternate protocols cache
 configurations to operate within a single Envoy process using different configurations. All
 alternate protocols cache options with the same name *must* be equal in all fields when
 referenced from different configuration components. Configuration will fail to load if this is
 not the case.
        string name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public AlternateProtocolsCacheOptions.Builder clearName()
         The name of the cache. Multiple named caches allow independent alternate protocols cache
 configurations to operate within a single Envoy process using different configurations. All
 alternate protocols cache options with the same name *must* be equal in all fields when
 referenced from different configuration components. Configuration will fail to load if this is
 not the case.
        string name = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setNameBytes

        public AlternateProtocolsCacheOptions.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The name of the cache. Multiple named caches allow independent alternate protocols cache
 configurations to operate within a single Envoy process using different configurations. All
 alternate protocols cache options with the same name *must* be equal in all fields when
 referenced from different configuration components. Configuration will fail to load if this is
 not the case.
        string name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasMaxEntries

        public boolean hasMaxEntries()
         The maximum number of entries that the cache will hold. If not specified defaults to 1024.
 .. note:
   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum entries in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
        .google.protobuf.UInt32Value max_entries = 2 [(.validate.rules) = { ... }
        Specified by:
        hasMaxEntries in interface AlternateProtocolsCacheOptionsOrBuilder
        Returns:
        Whether the maxEntries field is set.

      • getMaxEntries

        public com.google.protobuf.UInt32Value getMaxEntries()
         The maximum number of entries that the cache will hold. If not specified defaults to 1024.
 .. note:
   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum entries in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
        .google.protobuf.UInt32Value max_entries = 2 [(.validate.rules) = { ... }
        Specified by:
        getMaxEntries in interface AlternateProtocolsCacheOptionsOrBuilder
        Returns:
        The maxEntries.

      • setMaxEntries

        public AlternateProtocolsCacheOptions.Builder setMaxEntries​(com.google.protobuf.UInt32Value value)
         The maximum number of entries that the cache will hold. If not specified defaults to 1024.
 .. note:
   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum entries in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
        .google.protobuf.UInt32Value max_entries = 2 [(.validate.rules) = { ... }

      • setMaxEntries

        public AlternateProtocolsCacheOptions.Builder setMaxEntries​(com.google.protobuf.UInt32Value.Builder builderForValue)
         The maximum number of entries that the cache will hold. If not specified defaults to 1024.
 .. note:
   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum entries in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
        .google.protobuf.UInt32Value max_entries = 2 [(.validate.rules) = { ... }

      • mergeMaxEntries

        public AlternateProtocolsCacheOptions.Builder mergeMaxEntries​(com.google.protobuf.UInt32Value value)
         The maximum number of entries that the cache will hold. If not specified defaults to 1024.
 .. note:
   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum entries in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
        .google.protobuf.UInt32Value max_entries = 2 [(.validate.rules) = { ... }

      • clearMaxEntries

        public AlternateProtocolsCacheOptions.Builder clearMaxEntries()
         The maximum number of entries that the cache will hold. If not specified defaults to 1024.
 .. note:
   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum entries in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
        .google.protobuf.UInt32Value max_entries = 2 [(.validate.rules) = { ... }

      • getMaxEntriesBuilder

        public com.google.protobuf.UInt32Value.Builder getMaxEntriesBuilder()
         The maximum number of entries that the cache will hold. If not specified defaults to 1024.
 .. note:
   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum entries in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
        .google.protobuf.UInt32Value max_entries = 2 [(.validate.rules) = { ... }

      • getMaxEntriesOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getMaxEntriesOrBuilder()
         The maximum number of entries that the cache will hold. If not specified defaults to 1024.
 .. note:
   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum entries in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
        .google.protobuf.UInt32Value max_entries = 2 [(.validate.rules) = { ... }
        Specified by:
        getMaxEntriesOrBuilder in interface AlternateProtocolsCacheOptionsOrBuilder

      • hasKeyValueStoreConfig

        public boolean hasKeyValueStoreConfig()
         Allows configuring a persistent
 :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
 alternate protocols entries to disk.
 This function is currently only supported if concurrency is 1
 Cached entries will take precedence over pre-populated entries below.
        .envoy.config.core.v3.TypedExtensionConfig key_value_store_config = 3;
        Specified by:
        hasKeyValueStoreConfig in interface AlternateProtocolsCacheOptionsOrBuilder
        Returns:
        Whether the keyValueStoreConfig field is set.

      • getKeyValueStoreConfig

        public TypedExtensionConfig getKeyValueStoreConfig()
         Allows configuring a persistent
 :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
 alternate protocols entries to disk.
 This function is currently only supported if concurrency is 1
 Cached entries will take precedence over pre-populated entries below.
        .envoy.config.core.v3.TypedExtensionConfig key_value_store_config = 3;
        Specified by:
        getKeyValueStoreConfig in interface AlternateProtocolsCacheOptionsOrBuilder
        Returns:
        The keyValueStoreConfig.

      • setKeyValueStoreConfig

        public AlternateProtocolsCacheOptions.Builder setKeyValueStoreConfig​(TypedExtensionConfig value)
         Allows configuring a persistent
 :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
 alternate protocols entries to disk.
 This function is currently only supported if concurrency is 1
 Cached entries will take precedence over pre-populated entries below.
        .envoy.config.core.v3.TypedExtensionConfig key_value_store_config = 3;

      • setKeyValueStoreConfig

        public AlternateProtocolsCacheOptions.Builder setKeyValueStoreConfig​(TypedExtensionConfig.Builder builderForValue)
         Allows configuring a persistent
 :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
 alternate protocols entries to disk.
 This function is currently only supported if concurrency is 1
 Cached entries will take precedence over pre-populated entries below.
        .envoy.config.core.v3.TypedExtensionConfig key_value_store_config = 3;

      • mergeKeyValueStoreConfig

        public AlternateProtocolsCacheOptions.Builder mergeKeyValueStoreConfig​(TypedExtensionConfig value)
         Allows configuring a persistent
 :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
 alternate protocols entries to disk.
 This function is currently only supported if concurrency is 1
 Cached entries will take precedence over pre-populated entries below.
        .envoy.config.core.v3.TypedExtensionConfig key_value_store_config = 3;

      • clearKeyValueStoreConfig

        public AlternateProtocolsCacheOptions.Builder clearKeyValueStoreConfig()
         Allows configuring a persistent
 :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
 alternate protocols entries to disk.
 This function is currently only supported if concurrency is 1
 Cached entries will take precedence over pre-populated entries below.
        .envoy.config.core.v3.TypedExtensionConfig key_value_store_config = 3;

      • getKeyValueStoreConfigBuilder

        public TypedExtensionConfig.Builder getKeyValueStoreConfigBuilder()
         Allows configuring a persistent
 :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
 alternate protocols entries to disk.
 This function is currently only supported if concurrency is 1
 Cached entries will take precedence over pre-populated entries below.
        .envoy.config.core.v3.TypedExtensionConfig key_value_store_config = 3;

      • getKeyValueStoreConfigOrBuilder

        public TypedExtensionConfigOrBuilder getKeyValueStoreConfigOrBuilder()
         Allows configuring a persistent
 :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
 alternate protocols entries to disk.
 This function is currently only supported if concurrency is 1
 Cached entries will take precedence over pre-populated entries below.
        .envoy.config.core.v3.TypedExtensionConfig key_value_store_config = 3;
        Specified by:
        getKeyValueStoreConfigOrBuilder in interface AlternateProtocolsCacheOptionsOrBuilder

      • getPrepopulatedEntriesCount

        public int getPrepopulatedEntriesCount()
         Allows pre-populating the cache with entries, as described above.
        repeated .envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry prepopulated_entries = 4;
        Specified by:
        getPrepopulatedEntriesCount in interface AlternateProtocolsCacheOptionsOrBuilder

      • clearPrepopulatedEntries

        public AlternateProtocolsCacheOptions.Builder clearPrepopulatedEntries()
         Allows pre-populating the cache with entries, as described above.
        repeated .envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry prepopulated_entries = 4;

      • removePrepopulatedEntries

        public AlternateProtocolsCacheOptions.Builder removePrepopulatedEntries​(int index)
         Allows pre-populating the cache with entries, as described above.
        repeated .envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry prepopulated_entries = 4;

      • getPrepopulatedEntriesBuilder

        public AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry.Builder getPrepopulatedEntriesBuilder​(int index)
         Allows pre-populating the cache with entries, as described above.
        repeated .envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry prepopulated_entries = 4;

      • addPrepopulatedEntriesBuilder

        public AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry.Builder addPrepopulatedEntriesBuilder​(int index)
         Allows pre-populating the cache with entries, as described above.
        repeated .envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry prepopulated_entries = 4;