Package io.envoyproxy.envoy.extensions.health_checkers.redis.v3

Interface RedisOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    AwsIam
    getAwsIam()
    Use AWS IAM for health checker authentication
    AwsIamOrBuilder
    getAwsIamOrBuilder()
    Use AWS IAM for health checker authentication
    String
    getKey()
    If set, optionally perform ``EXISTS <key>`` instead of ``PING``.
    com.google.protobuf.ByteString
    getKeyBytes()
    If set, optionally perform ``EXISTS <key>`` instead of ``PING``.
    boolean
    hasAwsIam()
    Use AWS IAM for health checker 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

    • getKey

      String getKey()
       If set, optionally perform ``EXISTS <key>`` instead of ``PING``. A return value
 from Redis of 0 (does not exist) is considered a passing healthcheck. A return value other
 than 0 is considered a failure. This allows the user to mark a Redis instance for maintenance
 by setting the specified key to any value and waiting for traffic to drain.
      string key = 1;
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       If set, optionally perform ``EXISTS <key>`` instead of ``PING``. A return value
 from Redis of 0 (does not exist) is considered a passing healthcheck. A return value other
 than 0 is considered a failure. This allows the user to mark a Redis instance for maintenance
 by setting the specified key to any value and waiting for traffic to drain.
      string key = 1;
      Returns:
      The bytes for key.

    • hasAwsIam

      boolean hasAwsIam()
       Use AWS IAM for health checker authentication
      .envoy.extensions.filters.network.redis_proxy.v3.AwsIam aws_iam = 2;
      Returns:
      Whether the awsIam field is set.

    • getAwsIam

      AwsIam getAwsIam()
       Use AWS IAM for health checker authentication
      .envoy.extensions.filters.network.redis_proxy.v3.AwsIam aws_iam = 2;
      Returns:
      The awsIam.

    • getAwsIamOrBuilder

      AwsIamOrBuilder getAwsIamOrBuilder()
       Use AWS IAM for health checker authentication
      .envoy.extensions.filters.network.redis_proxy.v3.AwsIam aws_iam = 2;