Package io.envoyproxy.envoy.config.filter.network.client_ssl_auth.v2

Class ClientSSLAuth.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClientSSLAuthOrBuilder, Cloneable
    Enclosing class:
    ClientSSLAuth
    public static final class ClientSSLAuth.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ClientSSLAuth.Builder>
implements ClientSSLAuthOrBuilder
    Protobuf type envoy.config.filter.network.client_ssl_auth.v2.ClientSSLAuth

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

      • clear

        public ClientSSLAuth.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<ClientSSLAuth.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<ClientSSLAuth.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public ClientSSLAuth.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<ClientSSLAuth.Builder>

      • setField

        public ClientSSLAuth.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<ClientSSLAuth.Builder>

      • clearField

        public ClientSSLAuth.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<ClientSSLAuth.Builder>

      • clearOneof

        public ClientSSLAuth.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<ClientSSLAuth.Builder>

      • setRepeatedField

        public ClientSSLAuth.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<ClientSSLAuth.Builder>

      • addRepeatedField

        public ClientSSLAuth.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<ClientSSLAuth.Builder>

      • mergeFrom

        public ClientSSLAuth.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<ClientSSLAuth.Builder>

      • isInitialized

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

      • mergeFrom

        public ClientSSLAuth.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<ClientSSLAuth.Builder>
        Throws:
        IOException

      • getAuthApiCluster

        public String getAuthApiCluster()
         The :ref:`cluster manager <arch_overview_cluster_manager>` cluster that runs
 the authentication service. The filter will connect to the service every 60s to fetch the list
 of principals. The service must support the expected :ref:`REST API
 <config_network_filters_client_ssl_auth_rest_api>`.
        string auth_api_cluster = 1 [(.validate.rules) = { ... }
        Specified by:
        getAuthApiCluster in interface ClientSSLAuthOrBuilder
        Returns:
        The authApiCluster.

      • getAuthApiClusterBytes

        public com.google.protobuf.ByteString getAuthApiClusterBytes()
         The :ref:`cluster manager <arch_overview_cluster_manager>` cluster that runs
 the authentication service. The filter will connect to the service every 60s to fetch the list
 of principals. The service must support the expected :ref:`REST API
 <config_network_filters_client_ssl_auth_rest_api>`.
        string auth_api_cluster = 1 [(.validate.rules) = { ... }
        Specified by:
        getAuthApiClusterBytes in interface ClientSSLAuthOrBuilder
        Returns:
        The bytes for authApiCluster.

      • setAuthApiCluster

        public ClientSSLAuth.Builder setAuthApiCluster​(String value)
         The :ref:`cluster manager <arch_overview_cluster_manager>` cluster that runs
 the authentication service. The filter will connect to the service every 60s to fetch the list
 of principals. The service must support the expected :ref:`REST API
 <config_network_filters_client_ssl_auth_rest_api>`.
        string auth_api_cluster = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The authApiCluster to set.
        Returns:
        This builder for chaining.

      • clearAuthApiCluster

        public ClientSSLAuth.Builder clearAuthApiCluster()
         The :ref:`cluster manager <arch_overview_cluster_manager>` cluster that runs
 the authentication service. The filter will connect to the service every 60s to fetch the list
 of principals. The service must support the expected :ref:`REST API
 <config_network_filters_client_ssl_auth_rest_api>`.
        string auth_api_cluster = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setAuthApiClusterBytes

        public ClientSSLAuth.Builder setAuthApiClusterBytes​(com.google.protobuf.ByteString value)
         The :ref:`cluster manager <arch_overview_cluster_manager>` cluster that runs
 the authentication service. The filter will connect to the service every 60s to fetch the list
 of principals. The service must support the expected :ref:`REST API
 <config_network_filters_client_ssl_auth_rest_api>`.
        string auth_api_cluster = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for authApiCluster to set.
        Returns:
        This builder for chaining.

      • getStatPrefix

        public String getStatPrefix()
         The prefix to use when emitting :ref:`statistics
 <config_network_filters_client_ssl_auth_stats>`.
        string stat_prefix = 2 [(.validate.rules) = { ... }
        Specified by:
        getStatPrefix in interface ClientSSLAuthOrBuilder
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        public com.google.protobuf.ByteString getStatPrefixBytes()
         The prefix to use when emitting :ref:`statistics
 <config_network_filters_client_ssl_auth_stats>`.
        string stat_prefix = 2 [(.validate.rules) = { ... }
        Specified by:
        getStatPrefixBytes in interface ClientSSLAuthOrBuilder
        Returns:
        The bytes for statPrefix.

      • setStatPrefix

        public ClientSSLAuth.Builder setStatPrefix​(String value)
         The prefix to use when emitting :ref:`statistics
 <config_network_filters_client_ssl_auth_stats>`.
        string stat_prefix = 2 [(.validate.rules) = { ... }
        Parameters:
        value - The statPrefix to set.
        Returns:
        This builder for chaining.

      • clearStatPrefix

        public ClientSSLAuth.Builder clearStatPrefix()
         The prefix to use when emitting :ref:`statistics
 <config_network_filters_client_ssl_auth_stats>`.
        string stat_prefix = 2 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setStatPrefixBytes

        public ClientSSLAuth.Builder setStatPrefixBytes​(com.google.protobuf.ByteString value)
         The prefix to use when emitting :ref:`statistics
 <config_network_filters_client_ssl_auth_stats>`.
        string stat_prefix = 2 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for statPrefix to set.
        Returns:
        This builder for chaining.

      • hasRefreshDelay

        public boolean hasRefreshDelay()
         Time in milliseconds between principal refreshes from the
 authentication service. Default is 60000 (60s). The actual fetch time
 will be this value plus a random jittered value between
 0-refresh_delay_ms milliseconds.
        .google.protobuf.Duration refresh_delay = 3;
        Specified by:
        hasRefreshDelay in interface ClientSSLAuthOrBuilder
        Returns:
        Whether the refreshDelay field is set.

      • getRefreshDelay

        public com.google.protobuf.Duration getRefreshDelay()
         Time in milliseconds between principal refreshes from the
 authentication service. Default is 60000 (60s). The actual fetch time
 will be this value plus a random jittered value between
 0-refresh_delay_ms milliseconds.
        .google.protobuf.Duration refresh_delay = 3;
        Specified by:
        getRefreshDelay in interface ClientSSLAuthOrBuilder
        Returns:
        The refreshDelay.

      • setRefreshDelay

        public ClientSSLAuth.Builder setRefreshDelay​(com.google.protobuf.Duration value)
         Time in milliseconds between principal refreshes from the
 authentication service. Default is 60000 (60s). The actual fetch time
 will be this value plus a random jittered value between
 0-refresh_delay_ms milliseconds.
        .google.protobuf.Duration refresh_delay = 3;

      • setRefreshDelay

        public ClientSSLAuth.Builder setRefreshDelay​(com.google.protobuf.Duration.Builder builderForValue)
         Time in milliseconds between principal refreshes from the
 authentication service. Default is 60000 (60s). The actual fetch time
 will be this value plus a random jittered value between
 0-refresh_delay_ms milliseconds.
        .google.protobuf.Duration refresh_delay = 3;

      • mergeRefreshDelay

        public ClientSSLAuth.Builder mergeRefreshDelay​(com.google.protobuf.Duration value)
         Time in milliseconds between principal refreshes from the
 authentication service. Default is 60000 (60s). The actual fetch time
 will be this value plus a random jittered value between
 0-refresh_delay_ms milliseconds.
        .google.protobuf.Duration refresh_delay = 3;

      • clearRefreshDelay

        public ClientSSLAuth.Builder clearRefreshDelay()
         Time in milliseconds between principal refreshes from the
 authentication service. Default is 60000 (60s). The actual fetch time
 will be this value plus a random jittered value between
 0-refresh_delay_ms milliseconds.
        .google.protobuf.Duration refresh_delay = 3;

      • getRefreshDelayBuilder

        public com.google.protobuf.Duration.Builder getRefreshDelayBuilder()
         Time in milliseconds between principal refreshes from the
 authentication service. Default is 60000 (60s). The actual fetch time
 will be this value plus a random jittered value between
 0-refresh_delay_ms milliseconds.
        .google.protobuf.Duration refresh_delay = 3;

      • getRefreshDelayOrBuilder

        public com.google.protobuf.DurationOrBuilder getRefreshDelayOrBuilder()
         Time in milliseconds between principal refreshes from the
 authentication service. Default is 60000 (60s). The actual fetch time
 will be this value plus a random jittered value between
 0-refresh_delay_ms milliseconds.
        .google.protobuf.Duration refresh_delay = 3;
        Specified by:
        getRefreshDelayOrBuilder in interface ClientSSLAuthOrBuilder

      • getIpWhiteListList

        public List<CidrRange> getIpWhiteListList()
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;
        Specified by:
        getIpWhiteListList in interface ClientSSLAuthOrBuilder

      • getIpWhiteListCount

        public int getIpWhiteListCount()
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;
        Specified by:
        getIpWhiteListCount in interface ClientSSLAuthOrBuilder

      • getIpWhiteList

        public CidrRange getIpWhiteList​(int index)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;
        Specified by:
        getIpWhiteList in interface ClientSSLAuthOrBuilder

      • setIpWhiteList

        public ClientSSLAuth.Builder setIpWhiteList​(int index,
                                            CidrRange value)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • setIpWhiteList

        public ClientSSLAuth.Builder setIpWhiteList​(int index,
                                            CidrRange.Builder builderForValue)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • addIpWhiteList

        public ClientSSLAuth.Builder addIpWhiteList​(CidrRange value)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • addIpWhiteList

        public ClientSSLAuth.Builder addIpWhiteList​(int index,
                                            CidrRange value)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • addIpWhiteList

        public ClientSSLAuth.Builder addIpWhiteList​(CidrRange.Builder builderForValue)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • addIpWhiteList

        public ClientSSLAuth.Builder addIpWhiteList​(int index,
                                            CidrRange.Builder builderForValue)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • addAllIpWhiteList

        public ClientSSLAuth.Builder addAllIpWhiteList​(Iterable<? extends CidrRange> values)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • clearIpWhiteList

        public ClientSSLAuth.Builder clearIpWhiteList()
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • removeIpWhiteList

        public ClientSSLAuth.Builder removeIpWhiteList​(int index)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • getIpWhiteListBuilder

        public CidrRange.Builder getIpWhiteListBuilder​(int index)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • getIpWhiteListOrBuilder

        public CidrRangeOrBuilder getIpWhiteListOrBuilder​(int index)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;
        Specified by:
        getIpWhiteListOrBuilder in interface ClientSSLAuthOrBuilder

      • getIpWhiteListOrBuilderList

        public List<? extends CidrRangeOrBuilder> getIpWhiteListOrBuilderList()
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;
        Specified by:
        getIpWhiteListOrBuilderList in interface ClientSSLAuthOrBuilder

      • addIpWhiteListBuilder

        public CidrRange.Builder addIpWhiteListBuilder()
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • addIpWhiteListBuilder

        public CidrRange.Builder addIpWhiteListBuilder​(int index)
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • getIpWhiteListBuilderList

        public List<CidrRange.Builder> getIpWhiteListBuilderList()
         An optional list of IP address and subnet masks that should be white
 listed for access by the filter. If no list is provided, there is no
 IP allowlist.
        repeated .envoy.api.v2.core.CidrRange ip_white_list = 4;

      • setUnknownFields

        public final ClientSSLAuth.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<ClientSSLAuth.Builder>

      • mergeUnknownFields

        public final ClientSSLAuth.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<ClientSSLAuth.Builder>