Package io.deephaven.proto.auth

Class ClientId.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ClientId.Builder>
io.deephaven.proto.auth.ClientId.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClientIdOrBuilder, Cloneable
Enclosing class:
ClientId
public static final class ClientId.Builder extends com.google.protobuf.GeneratedMessage.Builder<ClientId.Builder> implements ClientIdOrBuilder
 A unique client identifier sent by clients to introduce themselves to servers.
Protobuf type io.deephaven.proto.auth.ClientId

  • Method Summary

    Modifier and Type
    Method
    Description
    ClientId
    build()
     
    ClientId
    buildPartial()
     
    ClientId.Builder
    clear()
     
    ClientId.Builder
    clearName()
    A string to identify this client in server side log files.
    ClientId.Builder
    clearUuid()
    A client uuid in bytes is created by client library code and used for the lifetime of that client process.
    ClientId
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getName()
    A string to identify this client in server side log files.
    com.google.protobuf.ByteString
    getNameBytes()
    A string to identify this client in server side log files.
    com.google.protobuf.ByteString
    getUuid()
    A client uuid in bytes is created by client library code and used for the lifetime of that client process.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    ClientId.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    ClientId.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    ClientId.Builder
    mergeFrom(ClientId other)
     
    ClientId.Builder
    setName(String value)
    A string to identify this client in server side log files.
    ClientId.Builder
    setNameBytes(com.google.protobuf.ByteString value)
    A string to identify this client in server side log files.
    ClientId.Builder
    setUuid(com.google.protobuf.ByteString value)
    A client uuid in bytes is created by client library code and used for the lifetime of that client process.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ClientId.Builder>

    • clear

      public ClientId.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.GeneratedMessage.Builder<ClientId.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.GeneratedMessage.Builder<ClientId.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ClientId.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<ClientId.Builder>

    • mergeFrom

      public ClientId.Builder mergeFrom(ClientId other)

    • isInitialized

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

    • mergeFrom

      public ClientId.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<ClientId.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       A string to identify this client in server side log files.
 This has no relation to username in authentication, it is exclusively a way for client programs
 to provide support for ease of debugging, by providing descriptive text.
 A good example could be `python reconciliation script running on machine a.b.c.d`.
 The server will only use this string in the initial logging for a client connection.
 The intent is to facilitate debugging when an administrator or user of this API needs to find
 the entries for a given client program in server logs.
 The protocol is designed so that uuid is enough for tracing unique clients, so this string
 is not strictly necessary; it may save effort for an admin (or yourself) in tracking down
 a uuid in a sea of machines however.
 Libraries built on top of this proto are expected to allow users to provide their own string
 (hopefully including explanatory documentation for the purpose in their API definition).
 When users do not provide one, libraries are expected to provide sensible defaults
 (eg, "python client running on machine a.b.c.d").
      string name = 1;
      Specified by:
      getName in interface ClientIdOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       A string to identify this client in server side log files.
 This has no relation to username in authentication, it is exclusively a way for client programs
 to provide support for ease of debugging, by providing descriptive text.
 A good example could be `python reconciliation script running on machine a.b.c.d`.
 The server will only use this string in the initial logging for a client connection.
 The intent is to facilitate debugging when an administrator or user of this API needs to find
 the entries for a given client program in server logs.
 The protocol is designed so that uuid is enough for tracing unique clients, so this string
 is not strictly necessary; it may save effort for an admin (or yourself) in tracking down
 a uuid in a sea of machines however.
 Libraries built on top of this proto are expected to allow users to provide their own string
 (hopefully including explanatory documentation for the purpose in their API definition).
 When users do not provide one, libraries are expected to provide sensible defaults
 (eg, "python client running on machine a.b.c.d").
      string name = 1;
      Specified by:
      getNameBytes in interface ClientIdOrBuilder
      Returns:
      The bytes for name.

    • setName

      public ClientId.Builder setName(String value)
       A string to identify this client in server side log files.
 This has no relation to username in authentication, it is exclusively a way for client programs
 to provide support for ease of debugging, by providing descriptive text.
 A good example could be `python reconciliation script running on machine a.b.c.d`.
 The server will only use this string in the initial logging for a client connection.
 The intent is to facilitate debugging when an administrator or user of this API needs to find
 the entries for a given client program in server logs.
 The protocol is designed so that uuid is enough for tracing unique clients, so this string
 is not strictly necessary; it may save effort for an admin (or yourself) in tracking down
 a uuid in a sea of machines however.
 Libraries built on top of this proto are expected to allow users to provide their own string
 (hopefully including explanatory documentation for the purpose in their API definition).
 When users do not provide one, libraries are expected to provide sensible defaults
 (eg, "python client running on machine a.b.c.d").
      string name = 1;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public ClientId.Builder clearName()
       A string to identify this client in server side log files.
 This has no relation to username in authentication, it is exclusively a way for client programs
 to provide support for ease of debugging, by providing descriptive text.
 A good example could be `python reconciliation script running on machine a.b.c.d`.
 The server will only use this string in the initial logging for a client connection.
 The intent is to facilitate debugging when an administrator or user of this API needs to find
 the entries for a given client program in server logs.
 The protocol is designed so that uuid is enough for tracing unique clients, so this string
 is not strictly necessary; it may save effort for an admin (or yourself) in tracking down
 a uuid in a sea of machines however.
 Libraries built on top of this proto are expected to allow users to provide their own string
 (hopefully including explanatory documentation for the purpose in their API definition).
 When users do not provide one, libraries are expected to provide sensible defaults
 (eg, "python client running on machine a.b.c.d").
      string name = 1;
      Returns:
      This builder for chaining.

    • setNameBytes

      public ClientId.Builder setNameBytes(com.google.protobuf.ByteString value)
       A string to identify this client in server side log files.
 This has no relation to username in authentication, it is exclusively a way for client programs
 to provide support for ease of debugging, by providing descriptive text.
 A good example could be `python reconciliation script running on machine a.b.c.d`.
 The server will only use this string in the initial logging for a client connection.
 The intent is to facilitate debugging when an administrator or user of this API needs to find
 the entries for a given client program in server logs.
 The protocol is designed so that uuid is enough for tracing unique clients, so this string
 is not strictly necessary; it may save effort for an admin (or yourself) in tracking down
 a uuid in a sea of machines however.
 Libraries built on top of this proto are expected to allow users to provide their own string
 (hopefully including explanatory documentation for the purpose in their API definition).
 When users do not provide one, libraries are expected to provide sensible defaults
 (eg, "python client running on machine a.b.c.d").
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getUuid

      public com.google.protobuf.ByteString getUuid()
       A client uuid in bytes is created by client library code and used for the lifetime of that client process.
 A client's uuid is expected by the server to be unique across all live client channels.
 If the same client process during its lifetime connects to different server processes,
 be it on different machines or different server process instances
 on the same machine (eg, server bounce), the client process is expected to use the same uuid to all servers.
 Note that uuids are a means for clients and servers to uniquely identify clients in log files;
 a uuid on its own is not enough to uniquely identify and trust a client session in the server.
 See 'cookie' in other messages below for a unique, and secret, client session identifier.
 The uuid is a user-visible unique name for a client, that can be used across non-overlapping sessions.
 The cookie is not user-visible and is provided by the protocol and required by the server to trust messages
 to have a particular client as origin.
      bytes uuid = 2;
      Specified by:
      getUuid in interface ClientIdOrBuilder
      Returns:
      The uuid.

    • setUuid

      public ClientId.Builder setUuid(com.google.protobuf.ByteString value)
       A client uuid in bytes is created by client library code and used for the lifetime of that client process.
 A client's uuid is expected by the server to be unique across all live client channels.
 If the same client process during its lifetime connects to different server processes,
 be it on different machines or different server process instances
 on the same machine (eg, server bounce), the client process is expected to use the same uuid to all servers.
 Note that uuids are a means for clients and servers to uniquely identify clients in log files;
 a uuid on its own is not enough to uniquely identify and trust a client session in the server.
 See 'cookie' in other messages below for a unique, and secret, client session identifier.
 The uuid is a user-visible unique name for a client, that can be used across non-overlapping sessions.
 The cookie is not user-visible and is provided by the protocol and required by the server to trust messages
 to have a particular client as origin.
      bytes uuid = 2;
      Parameters:
      value - The uuid to set.
      Returns:
      This builder for chaining.

    • clearUuid

      public ClientId.Builder clearUuid()
       A client uuid in bytes is created by client library code and used for the lifetime of that client process.
 A client's uuid is expected by the server to be unique across all live client channels.
 If the same client process during its lifetime connects to different server processes,
 be it on different machines or different server process instances
 on the same machine (eg, server bounce), the client process is expected to use the same uuid to all servers.
 Note that uuids are a means for clients and servers to uniquely identify clients in log files;
 a uuid on its own is not enough to uniquely identify and trust a client session in the server.
 See 'cookie' in other messages below for a unique, and secret, client session identifier.
 The uuid is a user-visible unique name for a client, that can be used across non-overlapping sessions.
 The cookie is not user-visible and is provided by the protocol and required by the server to trust messages
 to have a particular client as origin.
      bytes uuid = 2;
      Returns:
      This builder for chaining.