Package io.deephaven.proto.auth

Class AuthenticationResult.Builder

java.lang.Object
io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite.Builder
io.deephaven.shadow.core.com.google.protobuf.AbstractMessage.Builder<BuilderT>
io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>
io.deephaven.proto.auth.AuthenticationResult.Builder
All Implemented Interfaces:
AuthenticationResultOrBuilder, io.deephaven.shadow.core.com.google.protobuf.Message.Builder, io.deephaven.shadow.core.com.google.protobuf.MessageLite.Builder, io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder, io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AuthenticationResult
public static final class AuthenticationResult.Builder extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder> implements AuthenticationResultOrBuilder
 Servers respond to Authenticate* requests with an opaque cookie for the (client_id, user, effectiveUser) combination
 granted in the request.  clients remember and use the same cookie in subsequent RPCs to the server that intend to use
 those credentials. This cookie should be refreshed prior to the deadline, which is represented as milliseconds since
 epoch.  Clients are encouraged to refresh considerably in advance of the deadline, as to be able to continue
 operating under network delays.  The expected pattern is for clients to refresh half-way throught their
 available period from the last refresh to the deadline.
Protobuf type io.deephaven.proto.auth.AuthenticationResult

  • Method Details

    • getDescriptor

      public static final io.deephaven.shadow.core.com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>

    • clear

      public AuthenticationResult.Builder clear()
      Specified by:
      clear in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Specified by:
      clear in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>

    • getDescriptorForType

      public io.deephaven.shadow.core.com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>

    • getDefaultInstanceForType

      public AuthenticationResult getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder

    • build

      public AuthenticationResult build()
      Specified by:
      build in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Specified by:
      build in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite.Builder

    • buildPartial

      public AuthenticationResult buildPartial()
      Specified by:
      buildPartial in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite.Builder

    • clone

      public AuthenticationResult.Builder clone()
      Specified by:
      clone in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Specified by:
      clone in interface io.deephaven.shadow.core.com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>

    • setField

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

    • clearField

      public AuthenticationResult.Builder clearField(io.deephaven.shadow.core.com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Overrides:
      clearField in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>

    • clearOneof

      public AuthenticationResult.Builder clearOneof(io.deephaven.shadow.core.com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

      public AuthenticationResult.Builder mergeFrom(io.deephaven.shadow.core.com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class io.deephaven.shadow.core.com.google.protobuf.AbstractMessage.Builder<AuthenticationResult.Builder>

    • mergeFrom

      public AuthenticationResult.Builder mergeFrom(AuthenticationResult other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>

    • mergeFrom

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

    • getAuthenticated

      public boolean getAuthenticated()
       true if authentication was successful.
      bool authenticated = 1;
      Specified by:
      getAuthenticated in interface AuthenticationResultOrBuilder
      Returns:
      The authenticated.

    • setAuthenticated

      public AuthenticationResult.Builder setAuthenticated(boolean value)
       true if authentication was successful.
      bool authenticated = 1;
      Parameters:
      value - The authenticated to set.
      Returns:
      This builder for chaining.

    • clearAuthenticated

      public AuthenticationResult.Builder clearAuthenticated()
       true if authentication was successful.
      bool authenticated = 1;
      Returns:
      This builder for chaining.

    • getCookie

      public io.deephaven.shadow.core.com.google.protobuf.ByteString getCookie()
       the cookie that the client should remember and refresh before its deadline to remain authenticated.
      bytes cookie = 2;
      Specified by:
      getCookie in interface AuthenticationResultOrBuilder
      Returns:
      The cookie.

    • setCookie

      public AuthenticationResult.Builder setCookie(io.deephaven.shadow.core.com.google.protobuf.ByteString value)
       the cookie that the client should remember and refresh before its deadline to remain authenticated.
      bytes cookie = 2;
      Parameters:
      value - The cookie to set.
      Returns:
      This builder for chaining.

    • clearCookie

      public AuthenticationResult.Builder clearCookie()
       the cookie that the client should remember and refresh before its deadline to remain authenticated.
      bytes cookie = 2;
      Returns:
      This builder for chaining.

    • getCookieDeadlineTimeMillis

      public long getCookieDeadlineTimeMillis()
       the absolute time in milliseconds from the epoch when the cookie will expire.
      sfixed64 cookie_deadline_time_millis = 3;
      Specified by:
      getCookieDeadlineTimeMillis in interface AuthenticationResultOrBuilder
      Returns:
      The cookieDeadlineTimeMillis.

    • setCookieDeadlineTimeMillis

      public AuthenticationResult.Builder setCookieDeadlineTimeMillis(long value)
       the absolute time in milliseconds from the epoch when the cookie will expire.
      sfixed64 cookie_deadline_time_millis = 3;
      Parameters:
      value - The cookieDeadlineTimeMillis to set.
      Returns:
      This builder for chaining.

    • clearCookieDeadlineTimeMillis

      public AuthenticationResult.Builder clearCookieDeadlineTimeMillis()
       the absolute time in milliseconds from the epoch when the cookie will expire.
      sfixed64 cookie_deadline_time_millis = 3;
      Returns:
      This builder for chaining.

    • hasUserContext

      public boolean hasUserContext()
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;
      Specified by:
      hasUserContext in interface AuthenticationResultOrBuilder
      Returns:
      Whether the userContext field is set.

    • getUserContext

      public UserContext getUserContext()
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;
      Specified by:
      getUserContext in interface AuthenticationResultOrBuilder
      Returns:
      The userContext.

    • setUserContext

      public AuthenticationResult.Builder setUserContext(UserContext value)
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;

    • setUserContext

      public AuthenticationResult.Builder setUserContext(UserContext.Builder builderForValue)
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;

    • mergeUserContext

      public AuthenticationResult.Builder mergeUserContext(UserContext value)
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;

    • clearUserContext

      public AuthenticationResult.Builder clearUserContext()
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;

    • getUserContextBuilder

      public UserContext.Builder getUserContextBuilder()
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;

    • getUserContextOrBuilder

      public UserContextOrBuilder getUserContextOrBuilder()
       the user context actually authenticated; if there was one in the request should match it.
      .io.deephaven.proto.auth.UserContext userContext = 4;
      Specified by:
      getUserContextOrBuilder in interface AuthenticationResultOrBuilder

    • setUnknownFields

      public final AuthenticationResult.Builder setUnknownFields(io.deephaven.shadow.core.com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>

    • mergeUnknownFields

      public final AuthenticationResult.Builder mergeUnknownFields(io.deephaven.shadow.core.com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface io.deephaven.shadow.core.com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.Builder<AuthenticationResult.Builder>