Package io.envoyproxy.envoy.extensions.filters.network.redis_proxy.v3

Interface RedisProtocolOptionsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    DataSource
    getAuthPassword()
    Upstream server password as defined by the ``requirepass`` directive `<https://redis.io/topics/config>`_ in the server's configuration file.
    DataSourceOrBuilder
    getAuthPasswordOrBuilder()
    Upstream server password as defined by the ``requirepass`` directive `<https://redis.io/topics/config>`_ in the server's configuration file.
    DataSource
    getAuthUsername()
    Upstream server username as defined by the ``user`` directive `<https://redis.io/topics/acl>`_ in the server's configuration file.
    DataSourceOrBuilder
    getAuthUsernameOrBuilder()
    Upstream server username as defined by the ``user`` directive `<https://redis.io/topics/acl>`_ in the server's configuration file.
    AwsIam
    getAwsIam()
    The cluster level configuration for AWS IAM authentication
    AwsIamOrBuilder
    getAwsIamOrBuilder()
    The cluster level configuration for AWS IAM authentication
    RedisProtocolOptions.Credential
    getCredentials(int index)
    If specified, these credentials are used when connecting to upstream endpoints.
    int
    getCredentialsCount()
    If specified, these credentials are used when connecting to upstream endpoints.
    List<RedisProtocolOptions.Credential>
    getCredentialsList()
    If specified, these credentials are used when connecting to upstream endpoints.
    RedisProtocolOptions.CredentialOrBuilder
    getCredentialsOrBuilder(int index)
    If specified, these credentials are used when connecting to upstream endpoints.
    List<? extends RedisProtocolOptions.CredentialOrBuilder>
    getCredentialsOrBuilderList()
    If specified, these credentials are used when connecting to upstream endpoints.
    boolean
    hasAuthPassword()
    Upstream server password as defined by the ``requirepass`` directive `<https://redis.io/topics/config>`_ in the server's configuration file.
    boolean
    hasAuthUsername()
    Upstream server username as defined by the ``user`` directive `<https://redis.io/topics/acl>`_ in the server's configuration file.
    boolean
    hasAwsIam()
    The cluster level configuration for AWS IAM authentication

    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

    • hasAuthPassword

      boolean hasAuthPassword()
       Upstream server password as defined by the ``requirepass`` directive
 `<https://redis.io/topics/config>`_ in the server's configuration file.
 If ``aws_iam`` is set, this field is ignored.
      .envoy.config.core.v3.DataSource auth_password = 1 [(.udpa.annotations.sensitive) = true];
      Returns:
      Whether the authPassword field is set.

    • getAuthPassword

      DataSource getAuthPassword()
       Upstream server password as defined by the ``requirepass`` directive
 `<https://redis.io/topics/config>`_ in the server's configuration file.
 If ``aws_iam`` is set, this field is ignored.
      .envoy.config.core.v3.DataSource auth_password = 1 [(.udpa.annotations.sensitive) = true];
      Returns:
      The authPassword.

    • getAuthPasswordOrBuilder

      DataSourceOrBuilder getAuthPasswordOrBuilder()
       Upstream server password as defined by the ``requirepass`` directive
 `<https://redis.io/topics/config>`_ in the server's configuration file.
 If ``aws_iam`` is set, this field is ignored.
      .envoy.config.core.v3.DataSource auth_password = 1 [(.udpa.annotations.sensitive) = true];

    • hasAuthUsername

      boolean hasAuthUsername()
       Upstream server username as defined by the ``user`` directive
 `<https://redis.io/topics/acl>`_ in the server's configuration file.
 If ``aws_iam``` is set, this field will be used as the authenticating user for redis IAM authentication.
 See ``Create a new IAM-enabled user`` under `Setup <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html#auth-iam-setup>`_ for more details.
      .envoy.config.core.v3.DataSource auth_username = 2 [(.udpa.annotations.sensitive) = true];
      Returns:
      Whether the authUsername field is set.

    • getAuthUsername

      DataSource getAuthUsername()
       Upstream server username as defined by the ``user`` directive
 `<https://redis.io/topics/acl>`_ in the server's configuration file.
 If ``aws_iam``` is set, this field will be used as the authenticating user for redis IAM authentication.
 See ``Create a new IAM-enabled user`` under `Setup <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html#auth-iam-setup>`_ for more details.
      .envoy.config.core.v3.DataSource auth_username = 2 [(.udpa.annotations.sensitive) = true];
      Returns:
      The authUsername.

    • getAuthUsernameOrBuilder

      DataSourceOrBuilder getAuthUsernameOrBuilder()
       Upstream server username as defined by the ``user`` directive
 `<https://redis.io/topics/acl>`_ in the server's configuration file.
 If ``aws_iam``` is set, this field will be used as the authenticating user for redis IAM authentication.
 See ``Create a new IAM-enabled user`` under `Setup <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html#auth-iam-setup>`_ for more details.
      .envoy.config.core.v3.DataSource auth_username = 2 [(.udpa.annotations.sensitive) = true];

    • hasAwsIam

      boolean hasAwsIam()
       The cluster level configuration for AWS IAM authentication
      .envoy.extensions.filters.network.redis_proxy.v3.AwsIam aws_iam = 3;
      Returns:
      Whether the awsIam field is set.

    • getAwsIam

      AwsIam getAwsIam()
       The cluster level configuration for AWS IAM authentication
      .envoy.extensions.filters.network.redis_proxy.v3.AwsIam aws_iam = 3;
      Returns:
      The awsIam.

    • getAwsIamOrBuilder

      AwsIamOrBuilder getAwsIamOrBuilder()
       The cluster level configuration for AWS IAM authentication
      .envoy.extensions.filters.network.redis_proxy.v3.AwsIam aws_iam = 3;

    • getCredentialsList

      List<RedisProtocolOptions.Credential> getCredentialsList()
       If specified, these credentials are used when connecting to upstream endpoints. Which
 credential is used is determined by matching the resolved ``address`` field here with each
 endpoint's resolved ``address`` field. The first entry for a given ``address`` here takes precedence.
 If no entry in ``credentials`` matches, then the ``auth_password`` and ``auth_username`` fields
 are used as defaults.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProtocolOptions.Credential credentials = 4;

    • getCredentials

      RedisProtocolOptions.Credential getCredentials(int index)
       If specified, these credentials are used when connecting to upstream endpoints. Which
 credential is used is determined by matching the resolved ``address`` field here with each
 endpoint's resolved ``address`` field. The first entry for a given ``address`` here takes precedence.
 If no entry in ``credentials`` matches, then the ``auth_password`` and ``auth_username`` fields
 are used as defaults.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProtocolOptions.Credential credentials = 4;

    • getCredentialsCount

      int getCredentialsCount()
       If specified, these credentials are used when connecting to upstream endpoints. Which
 credential is used is determined by matching the resolved ``address`` field here with each
 endpoint's resolved ``address`` field. The first entry for a given ``address`` here takes precedence.
 If no entry in ``credentials`` matches, then the ``auth_password`` and ``auth_username`` fields
 are used as defaults.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProtocolOptions.Credential credentials = 4;

    • getCredentialsOrBuilderList

      List<? extends RedisProtocolOptions.CredentialOrBuilder> getCredentialsOrBuilderList()
       If specified, these credentials are used when connecting to upstream endpoints. Which
 credential is used is determined by matching the resolved ``address`` field here with each
 endpoint's resolved ``address`` field. The first entry for a given ``address`` here takes precedence.
 If no entry in ``credentials`` matches, then the ``auth_password`` and ``auth_username`` fields
 are used as defaults.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProtocolOptions.Credential credentials = 4;

    • getCredentialsOrBuilder

      RedisProtocolOptions.CredentialOrBuilder getCredentialsOrBuilder(int index)
       If specified, these credentials are used when connecting to upstream endpoints. Which
 credential is used is determined by matching the resolved ``address`` field here with each
 endpoint's resolved ``address`` field. The first entry for a given ``address`` here takes precedence.
 If no entry in ``credentials`` matches, then the ``auth_password`` and ``auth_username`` fields
 are used as defaults.
      repeated .envoy.extensions.filters.network.redis_proxy.v3.RedisProtocolOptions.Credential credentials = 4;