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

Class RedisProtocolOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.redis_proxy.v3.RedisProtocolOptions
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RedisProtocolOptionsOrBuilder, Serializable
public final class RedisProtocolOptions extends com.google.protobuf.GeneratedMessageV3 implements RedisProtocolOptionsOrBuilder
 RedisProtocolOptions specifies Redis upstream protocol options. This object is used in
 :ref:`typed_extension_protocol_options<envoy_v3_api_field_config.cluster.v3.Cluster.typed_extension_protocol_options>`,
 keyed by the name ``envoy.filters.network.redis_proxy``.
Protobuf type envoy.extensions.filters.network.redis_proxy.v3.RedisProtocolOptions
See Also:

  • Field Details

    • AUTH_PASSWORD_FIELD_NUMBER

      public static final int AUTH_PASSWORD_FIELD_NUMBER
      See Also:

    • AUTH_USERNAME_FIELD_NUMBER

      public static final int AUTH_USERNAME_FIELD_NUMBER
      See Also:

    • AWS_IAM_FIELD_NUMBER

      public static final int AWS_IAM_FIELD_NUMBER
      See Also:

    • CREDENTIALS_FIELD_NUMBER

      public static final int CREDENTIALS_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

    • hasAuthPassword

      public 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];
      Specified by:
      hasAuthPassword in interface RedisProtocolOptionsOrBuilder
      Returns:
      Whether the authPassword field is set.

    • getAuthPassword

      public 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];
      Specified by:
      getAuthPassword in interface RedisProtocolOptionsOrBuilder
      Returns:
      The authPassword.

    • getAuthPasswordOrBuilder

      public 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];
      Specified by:
      getAuthPasswordOrBuilder in interface RedisProtocolOptionsOrBuilder

    • hasAuthUsername

      public 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];
      Specified by:
      hasAuthUsername in interface RedisProtocolOptionsOrBuilder
      Returns:
      Whether the authUsername field is set.

    • getAuthUsername

      public 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];
      Specified by:
      getAuthUsername in interface RedisProtocolOptionsOrBuilder
      Returns:
      The authUsername.

    • getAuthUsernameOrBuilder

      public 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];
      Specified by:
      getAuthUsernameOrBuilder in interface RedisProtocolOptionsOrBuilder

    • hasAwsIam

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

    • getAwsIam

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

    • getAwsIamOrBuilder

      public AwsIamOrBuilder getAwsIamOrBuilder()
       The cluster level configuration for AWS IAM authentication
      .envoy.extensions.filters.network.redis_proxy.v3.AwsIam aws_iam = 3;
      Specified by:
      getAwsIamOrBuilder in interface RedisProtocolOptionsOrBuilder

    • getCredentialsList

      public 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;
      Specified by:
      getCredentialsList in interface RedisProtocolOptionsOrBuilder

    • getCredentialsOrBuilderList

      public 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;
      Specified by:
      getCredentialsOrBuilderList in interface RedisProtocolOptionsOrBuilder

    • getCredentialsCount

      public 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;
      Specified by:
      getCredentialsCount in interface RedisProtocolOptionsOrBuilder

    • getCredentials

      public 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;
      Specified by:
      getCredentials in interface RedisProtocolOptionsOrBuilder

    • getCredentialsOrBuilder

      public 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;
      Specified by:
      getCredentialsOrBuilder in interface RedisProtocolOptionsOrBuilder

    • 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 RedisProtocolOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RedisProtocolOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RedisProtocolOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RedisProtocolOptions.Builder newBuilder()

    • newBuilder

      public static RedisProtocolOptions.Builder newBuilder(RedisProtocolOptions prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RedisProtocolOptions getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RedisProtocolOptions> 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 RedisProtocolOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder