Package io.tiledb.cloud.rest_api.model

Class Invitation

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class Invitation
extends java.lang.Object
    Invitations to share or collaborate

    • Field Detail

      • SERIALIZED_NAME_ID

        public static final java.lang.String SERIALIZED_NAME_ID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_INVITATION_TYPE

        public static final java.lang.String SERIALIZED_NAME_INVITATION_TYPE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_OWNER_NAMESPACE_UUID

        public static final java.lang.String SERIALIZED_NAME_OWNER_NAMESPACE_UUID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_INVITER_UUID

        public static final java.lang.String SERIALIZED_NAME_INVITER_UUID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_USER_NAMESPACE_UUID

        public static final java.lang.String SERIALIZED_NAME_USER_NAMESPACE_UUID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ORGANIZATION_USER_UUID

        public static final java.lang.String SERIALIZED_NAME_ORGANIZATION_USER_UUID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ORGANIZATION_NAME

        public static final java.lang.String SERIALIZED_NAME_ORGANIZATION_NAME
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ORGANIZATION_ROLE

        public static final java.lang.String SERIALIZED_NAME_ORGANIZATION_ROLE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ORGANIZATION_UUID

        public static final java.lang.String SERIALIZED_NAME_ORGANIZATION_UUID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ARRAY_UUID

        public static final java.lang.String SERIALIZED_NAME_ARRAY_UUID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_GROUP_UUID

        public static final java.lang.String SERIALIZED_NAME_GROUP_UUID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ARRAY_NAME

        public static final java.lang.String SERIALIZED_NAME_ARRAY_NAME
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_EMAIL

        public static final java.lang.String SERIALIZED_NAME_EMAIL
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ACTIONS

        public static final java.lang.String SERIALIZED_NAME_ACTIONS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_GROUP_ACTIONS

        public static final java.lang.String SERIALIZED_NAME_GROUP_ACTIONS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_STATUS

        public static final java.lang.String SERIALIZED_NAME_STATUS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_CREATED_AT

        public static final java.lang.String SERIALIZED_NAME_CREATED_AT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_EXPIRES_AT

        public static final java.lang.String SERIALIZED_NAME_EXPIRES_AT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ACCEPTED_AT

        public static final java.lang.String SERIALIZED_NAME_ACCEPTED_AT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_NAMESPACE_INVITED

        public static final java.lang.String SERIALIZED_NAME_NAMESPACE_INVITED
        See Also:
        Constant Field Values

      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields

      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields

    • Constructor Detail

      • Invitation

        public Invitation()

    • Method Detail

      • id

        public Invitation id​(java.lang.String id)

      • getId

        @Nullable
public java.lang.String getId()
        Unique ID of invitation added to magic link
        Returns:
        id

      • setId

        public void setId​(java.lang.String id)

      • getInvitationType

        @Nullable
public InvitationType getInvitationType()
        Get invitationType
        Returns:
        invitationType

      • setInvitationType

        public void setInvitationType​(InvitationType invitationType)

      • ownerNamespaceUuid

        public Invitation ownerNamespaceUuid​(java.lang.String ownerNamespaceUuid)

      • getOwnerNamespaceUuid

        @Nullable
public java.lang.String getOwnerNamespaceUuid()
        Namespace of the owner of the invitation (user or organization)
        Returns:
        ownerNamespaceUuid

      • setOwnerNamespaceUuid

        public void setOwnerNamespaceUuid​(java.lang.String ownerNamespaceUuid)

      • inviterUuid

        public Invitation inviterUuid​(java.lang.String inviterUuid)

      • getInviterUuid

        @Nullable
public java.lang.String getInviterUuid()
        Unique ID of the user that sent the invitation
        Returns:
        inviterUuid

      • setInviterUuid

        public void setInviterUuid​(java.lang.String inviterUuid)

      • userNamespaceUuid

        public Invitation userNamespaceUuid​(java.lang.String userNamespaceUuid)

      • getUserNamespaceUuid

        @Nullable
public java.lang.String getUserNamespaceUuid()
        Unique ID of the user accepted the invitation
        Returns:
        userNamespaceUuid

      • setUserNamespaceUuid

        public void setUserNamespaceUuid​(java.lang.String userNamespaceUuid)

      • organizationUserUuid

        public Invitation organizationUserUuid​(java.lang.String organizationUserUuid)

      • getOrganizationUserUuid

        @Nullable
public java.lang.String getOrganizationUserUuid()
        Unique ID of the organization user accepted the invitation
        Returns:
        organizationUserUuid

      • setOrganizationUserUuid

        public void setOrganizationUserUuid​(java.lang.String organizationUserUuid)

      • organizationName

        public Invitation organizationName​(java.lang.String organizationName)

      • getOrganizationName

        @Nullable
public java.lang.String getOrganizationName()
        Name of the organization, does not persist in database
        Returns:
        organizationName

      • setOrganizationName

        public void setOrganizationName​(java.lang.String organizationName)

      • getOrganizationRole

        @Nullable
public OrganizationRoles getOrganizationRole()
        Get organizationRole
        Returns:
        organizationRole

      • setOrganizationRole

        public void setOrganizationRole​(OrganizationRoles organizationRole)

      • organizationUuid

        public Invitation organizationUuid​(java.lang.String organizationUuid)

      • getOrganizationUuid

        @Nullable
public java.lang.String getOrganizationUuid()
        Unique ID of the organization whose user(s) accepted the invitation
        Returns:
        organizationUuid

      • setOrganizationUuid

        public void setOrganizationUuid​(java.lang.String organizationUuid)

      • arrayUuid

        public Invitation arrayUuid​(java.lang.String arrayUuid)

      • getArrayUuid

        @Nullable
public java.lang.String getArrayUuid()
        Unique ID of the array
        Returns:
        arrayUuid

      • setArrayUuid

        public void setArrayUuid​(java.lang.String arrayUuid)

      • groupUuid

        public Invitation groupUuid​(java.lang.String groupUuid)

      • getGroupUuid

        @Nullable
public java.lang.String getGroupUuid()
        Unique ID of the group
        Returns:
        groupUuid

      • setGroupUuid

        public void setGroupUuid​(java.lang.String groupUuid)

      • arrayName

        public Invitation arrayName​(java.lang.String arrayName)

      • getArrayName

        @Nullable
public java.lang.String getArrayName()
        Name of the array, does not persist in database
        Returns:
        arrayName

      • setArrayName

        public void setArrayName​(java.lang.String arrayName)

      • email

        public Invitation email​(java.lang.String email)

      • getEmail

        @Nullable
public java.lang.String getEmail()
        Email of the individual we send the invitation to
        Returns:
        email

      • setEmail

        public void setEmail​(java.lang.String email)

      • actions

        public Invitation actions​(java.lang.String actions)

      • getActions

        @Nullable
public java.lang.String getActions()
        A comma separated list of ArrayActions or NamespaceActions
        Returns:
        actions

      • setActions

        public void setActions​(java.lang.String actions)

      • groupActions

        public Invitation groupActions​(java.lang.String groupActions)

      • getGroupActions

        @Nullable
public java.lang.String getGroupActions()
        A comma separated list of GroupActions
        Returns:
        groupActions

      • setGroupActions

        public void setGroupActions​(java.lang.String groupActions)

      • getStatus

        @Nullable
public InvitationStatus getStatus()
        Get status
        Returns:
        status

      • createdAt

        public Invitation createdAt​(java.time.OffsetDateTime createdAt)

      • getCreatedAt

        @Nullable
public java.time.OffsetDateTime getCreatedAt()
        Datetime the invitation was created in UTC
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(java.time.OffsetDateTime createdAt)

      • expiresAt

        public Invitation expiresAt​(java.time.OffsetDateTime expiresAt)

      • getExpiresAt

        @Nullable
public java.time.OffsetDateTime getExpiresAt()
        Datetime the invitation is expected to expire in UTC
        Returns:
        expiresAt

      • setExpiresAt

        public void setExpiresAt​(java.time.OffsetDateTime expiresAt)

      • acceptedAt

        public Invitation acceptedAt​(java.time.OffsetDateTime acceptedAt)

      • getAcceptedAt

        @Nullable
public java.time.OffsetDateTime getAcceptedAt()
        Datetime the invitation was accepted in UTC
        Returns:
        acceptedAt

      • setAcceptedAt

        public void setAcceptedAt​(java.time.OffsetDateTime acceptedAt)

      • namespaceInvited

        public Invitation namespaceInvited​(java.lang.String namespaceInvited)

      • getNamespaceInvited

        @Nullable
public java.lang.String getNamespaceInvited()
        The namespace invited (user or organization, if it exists in the DB)
        Returns:
        namespaceInvited

      • setNamespaceInvited

        public void setNamespaceInvited​(java.lang.String namespaceInvited)

      • putAdditionalProperty

        public Invitation putAdditionalProperty​(java.lang.String key,
                                        java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object is invalid with respect to Invitation

      • fromJson

        public static Invitation fromJson​(java.lang.String jsonString)
                           throws java.io.IOException
        Create an instance of Invitation given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of Invitation
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to Invitation

      • toJson

        public java.lang.String toJson()
        Convert an instance of Invitation to an JSON string
        Returns:
        JSON string