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

Class ClientSSLAuth

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.filter.network.client_ssl_auth.v2.ClientSSLAuth
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClientSSLAuthOrBuilder, 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AUTH_API_CLUSTER_FIELD_NUMBER
     
    static final int
    IP_WHITE_LIST_FIELD_NUMBER
     
    static final int
    REFRESH_DELAY_FIELD_NUMBER
     
    static final int
    STAT_PREFIX_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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 final 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.
    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.
    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()
     
    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>`.
    int
    hashCode()
     
    boolean
    hasRefreshDelay()
    Time in milliseconds between principal refreshes from the authentication service.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final 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 Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ClientSSLAuth
    parseDelimitedFrom(InputStream input)
     
    static ClientSSLAuth
    parseDelimitedFrom(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(InputStream input)
     
    static ClientSSLAuth
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ClientSSLAuth
    parseFrom(ByteBuffer data)
     
    static ClientSSLAuth
    parseFrom(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, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, hasField, hasOneof

  • Field Details

    • AUTH_API_CLUSTER_FIELD_NUMBER

      public static final int AUTH_API_CLUSTER_FIELD_NUMBER
      See Also:

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • REFRESH_DELAY_FIELD_NUMBER

      public static final int REFRESH_DELAY_FIELD_NUMBER
      See Also:

    • IP_WHITE_LIST_FIELD_NUMBER

      public static final int IP_WHITE_LIST_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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 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 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 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 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ClientSSLAuth parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ClientSSLAuth parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ClientSSLAuth.Builder newBuilder()

    • newBuilder

      public static ClientSSLAuth.Builder newBuilder(ClientSSLAuth prototype)

    • 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