Interface AlternateProtocolsCacheOptionsOrBuilder

    • Method Detail

      • getName

        java.lang.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) = { ... }
        Returns:
        The name.
      • getNameBytes

        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) = { ... }
        Returns:
        The bytes for name.
      • hasMaxEntries

        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) = { ... }
        Returns:
        Whether the maxEntries field is set.
      • getMaxEntries

        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) = { ... }
        Returns:
        The maxEntries.
      • getMaxEntriesOrBuilder

        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) = { ... }
      • hasKeyValueStoreConfig

        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;
        Returns:
        Whether the keyValueStoreConfig field is set.
      • getKeyValueStoreConfig

        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;
        Returns:
        The keyValueStoreConfig.
      • getKeyValueStoreConfigOrBuilder

        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;
      • getPrepopulatedEntriesList

        java.util.List<AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry> getPrepopulatedEntriesList()
         Allows pre-populating the cache with entries, as described above.
         
        repeated .envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry prepopulated_entries = 4;
      • getPrepopulatedEntries

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

        int getPrepopulatedEntriesCount()
         Allows pre-populating the cache with entries, as described above.
         
        repeated .envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry prepopulated_entries = 4;
      • getPrepopulatedEntriesOrBuilderList

        java.util.List<? extends AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntryOrBuilder> getPrepopulatedEntriesOrBuilderList()
         Allows pre-populating the cache with entries, as described above.
         
        repeated .envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry prepopulated_entries = 4;
      • getCanonicalSuffixesList

        java.util.List<java.lang.String> getCanonicalSuffixesList()
         Optional list of hostnames suffixes for which Alt-Svc entries can be shared. For example, if
         this list contained the value ``.c.example.com``, then an Alt-Svc entry for ``foo.c.example.com``
         could be shared with ``bar.c.example.com`` but would not be shared with ``baz.example.com``. On
         the other hand, if the list contained the value ``.example.com`` then all three hosts could share
         Alt-Svc entries. Each entry must start with ``.``. If a hostname matches multiple suffixes, the
         first listed suffix will be used.
        
         Since lookup in this list is O(n), it is recommended that the number of suffixes be limited.
         [#not-implemented-hide:]
         
        repeated string canonical_suffixes = 5;
        Returns:
        A list containing the canonicalSuffixes.
      • getCanonicalSuffixesCount

        int getCanonicalSuffixesCount()
         Optional list of hostnames suffixes for which Alt-Svc entries can be shared. For example, if
         this list contained the value ``.c.example.com``, then an Alt-Svc entry for ``foo.c.example.com``
         could be shared with ``bar.c.example.com`` but would not be shared with ``baz.example.com``. On
         the other hand, if the list contained the value ``.example.com`` then all three hosts could share
         Alt-Svc entries. Each entry must start with ``.``. If a hostname matches multiple suffixes, the
         first listed suffix will be used.
        
         Since lookup in this list is O(n), it is recommended that the number of suffixes be limited.
         [#not-implemented-hide:]
         
        repeated string canonical_suffixes = 5;
        Returns:
        The count of canonicalSuffixes.
      • getCanonicalSuffixes

        java.lang.String getCanonicalSuffixes​(int index)
         Optional list of hostnames suffixes for which Alt-Svc entries can be shared. For example, if
         this list contained the value ``.c.example.com``, then an Alt-Svc entry for ``foo.c.example.com``
         could be shared with ``bar.c.example.com`` but would not be shared with ``baz.example.com``. On
         the other hand, if the list contained the value ``.example.com`` then all three hosts could share
         Alt-Svc entries. Each entry must start with ``.``. If a hostname matches multiple suffixes, the
         first listed suffix will be used.
        
         Since lookup in this list is O(n), it is recommended that the number of suffixes be limited.
         [#not-implemented-hide:]
         
        repeated string canonical_suffixes = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The canonicalSuffixes at the given index.
      • getCanonicalSuffixesBytes

        com.google.protobuf.ByteString getCanonicalSuffixesBytes​(int index)
         Optional list of hostnames suffixes for which Alt-Svc entries can be shared. For example, if
         this list contained the value ``.c.example.com``, then an Alt-Svc entry for ``foo.c.example.com``
         could be shared with ``bar.c.example.com`` but would not be shared with ``baz.example.com``. On
         the other hand, if the list contained the value ``.example.com`` then all three hosts could share
         Alt-Svc entries. Each entry must start with ``.``. If a hostname matches multiple suffixes, the
         first listed suffix will be used.
        
         Since lookup in this list is O(n), it is recommended that the number of suffixes be limited.
         [#not-implemented-hide:]
         
        repeated string canonical_suffixes = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the canonicalSuffixes at the given index.