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

Class RedisExternalAuthProvider.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>
io.envoyproxy.envoy.extensions.filters.network.redis_proxy.v3.RedisExternalAuthProvider.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RedisExternalAuthProviderOrBuilder, Cloneable
Enclosing class:
RedisExternalAuthProvider
public static final class RedisExternalAuthProvider.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder> implements RedisExternalAuthProviderOrBuilder
 RedisExternalAuthProvider specifies a gRPC service that can be used to authenticate Redis clients.
 This service will be called every time an AUTH command is received from a client.
 If the service returns an error, authentication is considered failed.
 If the service returns a success, the client is considered authenticated.
 The service can also return an expiration timestamp, which will be used to disable any further
 commands from the client after it passes, unless a new AUTH command is received and the
 external auth service returns a new expiration timestamp.
Protobuf type envoy.extensions.filters.network.redis_proxy.v3.RedisExternalAuthProvider

  • Method Details

    • 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.Builder<RedisExternalAuthProvider.Builder>

    • clear

      public RedisExternalAuthProvider.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • getDefaultInstanceForType

      public RedisExternalAuthProvider getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public RedisExternalAuthProvider build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RedisExternalAuthProvider buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public RedisExternalAuthProvider.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • setField

      public RedisExternalAuthProvider.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • clearField

      public RedisExternalAuthProvider.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • clearOneof

      public RedisExternalAuthProvider.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • setRepeatedField

      public RedisExternalAuthProvider.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • addRepeatedField

      public RedisExternalAuthProvider.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • mergeFrom

      public RedisExternalAuthProvider.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedisExternalAuthProvider.Builder>

    • mergeFrom

      public RedisExternalAuthProvider.Builder mergeFrom(RedisExternalAuthProvider other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • mergeFrom

      public RedisExternalAuthProvider.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RedisExternalAuthProvider.Builder>
      Throws:
      IOException

    • hasGrpcService

      public boolean hasGrpcService()
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;
      Specified by:
      hasGrpcService in interface RedisExternalAuthProviderOrBuilder
      Returns:
      Whether the grpcService field is set.

    • getGrpcService

      public GrpcService getGrpcService()
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;
      Specified by:
      getGrpcService in interface RedisExternalAuthProviderOrBuilder
      Returns:
      The grpcService.

    • setGrpcService

      public RedisExternalAuthProvider.Builder setGrpcService(GrpcService value)
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;

    • setGrpcService

      public RedisExternalAuthProvider.Builder setGrpcService(GrpcService.Builder builderForValue)
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;

    • mergeGrpcService

      public RedisExternalAuthProvider.Builder mergeGrpcService(GrpcService value)
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;

    • clearGrpcService

      public RedisExternalAuthProvider.Builder clearGrpcService()
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;

    • getGrpcServiceBuilder

      public GrpcService.Builder getGrpcServiceBuilder()
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;

    • getGrpcServiceOrBuilder

      public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;
      Specified by:
      getGrpcServiceOrBuilder in interface RedisExternalAuthProviderOrBuilder

    • getEnableAuthExpiration

      public boolean getEnableAuthExpiration()
       If set to true, the filter will expect an expiration timestamp in the response from the external
 auth service. This timestamp will be used to disable any further commands from the client after
 the expiration time, unless a new AUTH command is received and the external auth service returns
 a new expiration timestamp.
      bool enable_auth_expiration = 2;
      Specified by:
      getEnableAuthExpiration in interface RedisExternalAuthProviderOrBuilder
      Returns:
      The enableAuthExpiration.

    • setEnableAuthExpiration

      public RedisExternalAuthProvider.Builder setEnableAuthExpiration(boolean value)
       If set to true, the filter will expect an expiration timestamp in the response from the external
 auth service. This timestamp will be used to disable any further commands from the client after
 the expiration time, unless a new AUTH command is received and the external auth service returns
 a new expiration timestamp.
      bool enable_auth_expiration = 2;
      Parameters:
      value - The enableAuthExpiration to set.
      Returns:
      This builder for chaining.

    • clearEnableAuthExpiration

      public RedisExternalAuthProvider.Builder clearEnableAuthExpiration()
       If set to true, the filter will expect an expiration timestamp in the response from the external
 auth service. This timestamp will be used to disable any further commands from the client after
 the expiration time, unless a new AUTH command is received and the external auth service returns
 a new expiration timestamp.
      bool enable_auth_expiration = 2;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final RedisExternalAuthProvider.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>

    • mergeUnknownFields

      public final RedisExternalAuthProvider.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RedisExternalAuthProvider.Builder>