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

Interface ClientSSLAuthOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ClientSSLAuth, ClientSSLAuth.Builder
public interface ClientSSLAuthOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.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.
    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>`.
    boolean
    hasRefreshDelay()
    Time in milliseconds between principal refreshes from the authentication service.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getAuthApiCluster

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

    • getAuthApiClusterBytes

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

    • getStatPrefix

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

    • getStatPrefixBytes

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

    • hasRefreshDelay

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

    • getRefreshDelay

      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;
      Returns:
      The refreshDelay.

    • getRefreshDelayOrBuilder

      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;

    • getIpWhiteListList

      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;

    • getIpWhiteList

      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;

    • getIpWhiteListCount

      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;

    • getIpWhiteListOrBuilderList

      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;

    • getIpWhiteListOrBuilder

      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;