Package io.deephaven.proto.auth

Interface AuthenticateByExternalRequestOrBuilder

All Superinterfaces:
io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder, io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AuthenticateByExternalRequest, AuthenticateByExternalRequest.Builder
@Generated public interface AuthenticateByExternalRequestOrBuilder extends io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    ClientId
    getClientId()
    the client id for the client making the request.
    ClientIdOrBuilder
    getClientIdOrBuilder()
    the client id for the client making the request.
    boolean
    getDoNotForward()
    clients should always send the default of false and otherwise ignore this field, this field is only for auth server implementation use.
    String
    getKey()
    the key for external authentication.
    io.deephaven.shadow.core.com.google.protobuf.ByteString
    getKeyBytes()
    the key for external authentication.
    boolean
    hasClientId()
    the client id for the client making the request.

    Methods inherited from interface io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasClientId

      boolean hasClientId()
       the client id for the client making the request.
      .io.deephaven.proto.auth.ClientId client_id = 1;
      Returns:
      Whether the clientId field is set.

    • getClientId

      ClientId getClientId()
       the client id for the client making the request.
      .io.deephaven.proto.auth.ClientId client_id = 1;
      Returns:
      The clientId.

    • getClientIdOrBuilder

      ClientIdOrBuilder getClientIdOrBuilder()
       the client id for the client making the request.
      .io.deephaven.proto.auth.ClientId client_id = 1;

    • getKey

      String getKey()
       the key for external authentication.
      string key = 2;
      Returns:
      The key.

    • getKeyBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getKeyBytes()
       the key for external authentication.
      string key = 2;
      Returns:
      The bytes for key.

    • getDoNotForward

      boolean getDoNotForward()
       clients should always send the default of false and otherwise ignore this field,
 this field is only for auth server implementation use.
 If true (which can only set by an auth server forwarding to another),
 only answer the request on the receiving server itself.
      bool do_not_forward = 3;
      Returns:
      The doNotForward.