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

Class ClientSSLAuth

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClientSSLAuthOrBuilder, java.io.Serializable
    public final class ClientSSLAuth
extends com.google.protobuf.GeneratedMessageV3
implements ClientSSLAuthOrBuilder
    Protobuf type envoy.config.filter.network.client_ssl_auth.v2.ClientSSLAuth
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ClientSSLAuth.Builder
      Protobuf type envoy.config.filter.network.client_ssl_auth.v2.ClientSSLAuth

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAuthApiCluster()
      The :ref:`cluster manager <arch_overview_cluster_manager>` cluster that runs the authentication service.
      com.google.protobuf.ByteString getAuthApiClusterBytes()
      The :ref:`cluster manager <arch_overview_cluster_manager>` cluster that runs the authentication service.
      static ClientSSLAuth getDefaultInstance()  
      ClientSSLAuth getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      CidrRange getIpWhiteList​(int index)
      An optional list of IP address and subnet masks that should be white listed for access by the filter.
      int getIpWhiteListCount()
      An optional list of IP address and subnet masks that should be white listed for access by the filter.
      java.util.List<CidrRange> getIpWhiteListList()
      An optional list of IP address and subnet masks that should be white listed for access by the filter.
      CidrRangeOrBuilder getIpWhiteListOrBuilder​(int index)
      An optional list of IP address and subnet masks that should be white listed for access by the filter.
      java.util.List<? extends CidrRangeOrBuilder> getIpWhiteListOrBuilderList()
      An optional list of IP address and subnet masks that should be white listed for access by the filter.
      com.google.protobuf.Parser<ClientSSLAuth> getParserForType()  
      com.google.protobuf.Duration getRefreshDelay()
      Time in milliseconds between principal refreshes from the authentication service.
      com.google.protobuf.DurationOrBuilder getRefreshDelayOrBuilder()
      Time in milliseconds between principal refreshes from the authentication service.
      int getSerializedSize()  
      java.lang.String getStatPrefix()
      The prefix to use when emitting :ref:`statistics <config_network_filters_client_ssl_auth_stats>`.
      com.google.protobuf.ByteString getStatPrefixBytes()
      The prefix to use when emitting :ref:`statistics <config_network_filters_client_ssl_auth_stats>`.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      boolean hasRefreshDelay()
      Time in milliseconds between principal refreshes from the authentication service.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ClientSSLAuth.Builder newBuilder()  
      static ClientSSLAuth.Builder newBuilder​(ClientSSLAuth prototype)  
      ClientSSLAuth.Builder newBuilderForType()  
      protected ClientSSLAuth.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ClientSSLAuth parseDelimitedFrom​(java.io.InputStream input)  
      static ClientSSLAuth parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ClientSSLAuth parseFrom​(byte[] data)  
      static ClientSSLAuth parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ClientSSLAuth parseFrom​(com.google.protobuf.ByteString data)  
      static ClientSSLAuth parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ClientSSLAuth parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ClientSSLAuth parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ClientSSLAuth parseFrom​(java.io.InputStream input)  
      static ClientSSLAuth parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ClientSSLAuth parseFrom​(java.nio.ByteBuffer data)  
      static ClientSSLAuth parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ClientSSLAuth> parser()  
      ClientSSLAuth.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

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

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

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

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Field Detail

      • AUTH_API_CLUSTER_FIELD_NUMBER

        public static final int AUTH_API_CLUSTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STAT_PREFIX_FIELD_NUMBER

        public static final int STAT_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REFRESH_DELAY_FIELD_NUMBER

        public static final int REFRESH_DELAY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IP_WHITE_LIST_FIELD_NUMBER

        public static final int IP_WHITE_LIST_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • getAuthApiCluster

        public java.lang.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.

      • getStatPrefix

        public java.lang.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.

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

      • 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 java.util.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

      • getIpWhiteListOrBuilderList

        public java.util.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

      • 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

      • 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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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 ClientSSLAuth parseFrom​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ClientSSLAuth parseFrom​(java.nio.ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ClientSSLAuth parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static ClientSSLAuth parseFrom​(java.io.InputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ClientSSLAuth parseFrom​(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ClientSSLAuth parseDelimitedFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ClientSSLAuth parseDelimitedFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ClientSSLAuth parseFrom​(com.google.protobuf.CodedInputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ClientSSLAuth parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ClientSSLAuth.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ClientSSLAuth getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<ClientSSLAuth> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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