Class UserCreateRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.UserCreateRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UserCreateRequestOrBuilder, Serializable
@Generated public final class UserCreateRequest extends com.google.protobuf.GeneratedMessage implements UserCreateRequestOrBuilder
Request message for creating a new user account in the SoulFire system.
The created user will have no password; authentication is done via JWT tokens.
Protobuf type soulfire.v1.UserCreateRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    UserCreateRequest.Builder
    Request message for creating a new user account in the SoulFire system.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EMAIL_FIELD_NUMBER
     
    static final int
    ROLE_FIELD_NUMBER
     
    static final int
    USERNAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static UserCreateRequest
    getDefaultInstance()
     
    UserCreateRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEmail()
    The email address for the user.
    com.google.protobuf.ByteString
    getEmailBytes()
    The email address for the user.
    com.google.protobuf.Parser<UserCreateRequest>
    getParserForType()
     
    UserRole
    getRole()
    The role to assign to the user.
    int
    getRoleValue()
    The role to assign to the user.
    int
    getSerializedSize()
     
    String
    getUsername()
    The username for the new user.
    com.google.protobuf.ByteString
    getUsernameBytes()
    The username for the new user.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static UserCreateRequest.Builder
    newBuilder()
     
    static UserCreateRequest.Builder
    newBuilder(UserCreateRequest prototype)
     
    UserCreateRequest.Builder
    newBuilderForType()
     
    protected UserCreateRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static UserCreateRequest
    parseDelimitedFrom(InputStream input)
     
    static UserCreateRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserCreateRequest
    parseFrom(byte[] data)
     
    static UserCreateRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserCreateRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static UserCreateRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserCreateRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static UserCreateRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserCreateRequest
    parseFrom(InputStream input)
     
    static UserCreateRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserCreateRequest
    parseFrom(ByteBuffer data)
     
    static UserCreateRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<UserCreateRequest>
    parser()
     
    UserCreateRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • 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

    • getUsername

      public String getUsername()
      The username for the new user.
Must be lowercase, between 3 and 32 characters.
Must begin with an alphanumeric character, followed by alphanumeric characters or dashes,
and end with an alphanumeric character.
Must be unique across all users.
      string username = 1;
      Specified by:
      getUsername in interface UserCreateRequestOrBuilder
      Returns:
      The username.

    • getUsernameBytes

      public com.google.protobuf.ByteString getUsernameBytes()
      The username for the new user.
Must be lowercase, between 3 and 32 characters.
Must begin with an alphanumeric character, followed by alphanumeric characters or dashes,
and end with an alphanumeric character.
Must be unique across all users.
      string username = 1;
      Specified by:
      getUsernameBytes in interface UserCreateRequestOrBuilder
      Returns:
      The bytes for username.

    • getRoleValue

      public int getRoleValue()
      The role to assign to the user. Determines what permissions the user has.
ADMIN users have all permissions, while USER role has limited permissions
controlled by server settings.
      .soulfire.v1.UserRole role = 2;
      Specified by:
      getRoleValue in interface UserCreateRequestOrBuilder
      Returns:
      The enum numeric value on the wire for role.

    • getRole

      public UserRole getRole()
      The role to assign to the user. Determines what permissions the user has.
ADMIN users have all permissions, while USER role has limited permissions
controlled by server settings.
      .soulfire.v1.UserRole role = 2;
      Specified by:
      getRole in interface UserCreateRequestOrBuilder
      Returns:
      The role.

    • getEmail

      public String getEmail()
      The email address for the user.
Must be a valid email format and unique across all users.
Maximum length is 255 characters.
      string email = 3;
      Specified by:
      getEmail in interface UserCreateRequestOrBuilder
      Returns:
      The email.

    • getEmailBytes

      public com.google.protobuf.ByteString getEmailBytes()
      The email address for the user.
Must be a valid email format and unique across all users.
Maximum length is 255 characters.
      string email = 3;
      Specified by:
      getEmailBytes in interface UserCreateRequestOrBuilder
      Returns:
      The bytes for email.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UserCreateRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserCreateRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserCreateRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserCreateRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserCreateRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserCreateRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserCreateRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserCreateRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UserCreateRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UserCreateRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserCreateRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserCreateRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UserCreateRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UserCreateRequest.Builder newBuilder()

    • newBuilder

      public static UserCreateRequest.Builder newBuilder(UserCreateRequest prototype)

    • toBuilder

      public UserCreateRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UserCreateRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static UserCreateRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UserCreateRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<UserCreateRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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