Package io.tiledb.cloud.rest_api.model

Class ArrayInfo

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-02T12:25:58.319138+03:00[Europe/Athens]")
public class ArrayInfo
extends java.lang.Object
    metadata of an array

    • Field Detail

      • SERIALIZED_NAME_ID

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

      • SERIALIZED_NAME_FILE_TYPE

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

      • SERIALIZED_NAME_FILE_PROPERTIES

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

      • SERIALIZED_NAME_URI

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

      • SERIALIZED_NAME_NAMESPACE

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

      • SERIALIZED_NAME_SIZE

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

      • SERIALIZED_NAME_LAST_ACCESSED

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

      • SERIALIZED_NAME_DESCRIPTION

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

      • SERIALIZED_NAME_NAME

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

      • SERIALIZED_NAME_ALLOWED_ACTIONS

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

      • SERIALIZED_NAME_PRICING

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

      • SERIALIZED_NAME_SUBSCRIPTIONS

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

      • SERIALIZED_NAME_LOGO

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

      • SERIALIZED_NAME_ACCESS_CREDENTIALS_NAME

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

      • SERIALIZED_NAME_TYPE

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

      • SERIALIZED_NAME_SHARE_COUNT

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

      • SERIALIZED_NAME_PUBLIC_SHARE

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

      • SERIALIZED_NAME_NAMESPACE_SUBSCRIBED

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

      • SERIALIZED_NAME_TILEDB_URI

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

      • SERIALIZED_NAME_TAGS

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

      • SERIALIZED_NAME_LICENSE_ID

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

      • SERIALIZED_NAME_LICENSE_TEXT

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

      • SERIALIZED_NAME_READ_ONLY

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

      • SERIALIZED_NAME_IS_FAVORITE

        public static final java.lang.String SERIALIZED_NAME_IS_FAVORITE
        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

      • ArrayInfo

        public ArrayInfo()

      • ArrayInfo

        public ArrayInfo​(java.lang.Boolean namespaceSubscribed)

    • Method Detail

      • id

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

      • getId

        @Nullable
public java.lang.String getId()
        unique ID of registered array
        Returns:
        id

      • setId

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

      • getFileType

        @Nullable
public FileType getFileType()
        Get fileType
        Returns:
        fileType

      • setFileType

        public void setFileType​(FileType fileType)

      • fileProperties

        public ArrayInfo fileProperties​(java.util.Map<java.lang.String,​java.lang.String> fileProperties)

      • putFilePropertiesItem

        public ArrayInfo putFilePropertiesItem​(java.lang.String key,
                                       java.lang.String filePropertiesItem)

      • getFileProperties

        @Nullable
public java.util.Map<java.lang.String,​java.lang.String> getFileProperties()
        map of file properties created for this array
        Returns:
        fileProperties

      • setFileProperties

        public void setFileProperties​(java.util.Map<java.lang.String,​java.lang.String> fileProperties)

      • uri

        public ArrayInfo uri​(java.lang.String uri)

      • getUri

        @Nullable
public java.lang.String getUri()
        uri of array
        Returns:
        uri

      • setUri

        public void setUri​(java.lang.String uri)

      • namespace

        public ArrayInfo namespace​(java.lang.String namespace)

      • getNamespace

        @Nullable
public java.lang.String getNamespace()
        namespace array is in
        Returns:
        namespace

      • setNamespace

        public void setNamespace​(java.lang.String namespace)

      • size

        public ArrayInfo size​(java.math.BigDecimal size)

      • getSize

        @Nullable
public java.math.BigDecimal getSize()
        size in bytes of array
        Returns:
        size

      • setSize

        public void setSize​(java.math.BigDecimal size)

      • lastAccessed

        public ArrayInfo lastAccessed​(java.time.OffsetDateTime lastAccessed)

      • getLastAccessed

        @Nullable
public java.time.OffsetDateTime getLastAccessed()
        Datetime array was last accessed in UTC
        Returns:
        lastAccessed

      • setLastAccessed

        public void setLastAccessed​(java.time.OffsetDateTime lastAccessed)

      • description

        public ArrayInfo description​(java.lang.String description)

      • getDescription

        @Nullable
public java.lang.String getDescription()
        description of array
        Returns:
        description

      • setDescription

        public void setDescription​(java.lang.String description)

      • name

        public ArrayInfo name​(java.lang.String name)

      • getName

        @Nullable
public java.lang.String getName()
        name of array
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)

      • getAllowedActions

        @Nullable
public java.util.List<ArrayActions> getAllowedActions()
        list of actions user is allowed to do on this array
        Returns:
        allowedActions

      • setAllowedActions

        public void setAllowedActions​(java.util.List<ArrayActions> allowedActions)

      • getPricing

        @Nullable
public java.util.List<Pricing> getPricing()
        list of pricing created for this array
        Returns:
        pricing

      • setPricing

        public void setPricing​(java.util.List<Pricing> pricing)

      • getSubscriptions

        @Nullable
public java.util.List<Subscription> getSubscriptions()
        list of subscriptions created for this array
        Returns:
        subscriptions

      • setSubscriptions

        public void setSubscriptions​(java.util.List<Subscription> subscriptions)

      • logo

        public ArrayInfo logo​(java.lang.String logo)

      • getLogo

        @Nullable
public java.lang.String getLogo()
        logo (base64 encoded) for the array. Optional
        Returns:
        logo

      • setLogo

        public void setLogo​(java.lang.String logo)

      • accessCredentialsName

        public ArrayInfo accessCredentialsName​(java.lang.String accessCredentialsName)

      • getAccessCredentialsName

        @Nullable
public java.lang.String getAccessCredentialsName()
        the name of the access credentials to use. if unset, the default credentials will be used
        Returns:
        accessCredentialsName

      • setAccessCredentialsName

        public void setAccessCredentialsName​(java.lang.String accessCredentialsName)

      • getType

        @Nullable
public ArrayType getType()
        Get type
        Returns:
        type

      • setType

        public void setType​(ArrayType type)

      • shareCount

        public ArrayInfo shareCount​(java.math.BigDecimal shareCount)

      • getShareCount

        @Nullable
public java.math.BigDecimal getShareCount()
        number of unique namespaces this array is shared with
        Returns:
        shareCount

      • setShareCount

        public void setShareCount​(java.math.BigDecimal shareCount)

      • publicShare

        public ArrayInfo publicShare​(java.lang.Boolean publicShare)

      • getPublicShare

        @Nullable
public java.lang.Boolean getPublicShare()
        Suggests if the array was shared to public by owner
        Returns:
        publicShare

      • setPublicShare

        public void setPublicShare​(java.lang.Boolean publicShare)

      • getNamespaceSubscribed

        @Nullable
public java.lang.Boolean getNamespaceSubscribed()
        Depends on the namespace asking, denotes the existence of subscription of namespace to this array
        Returns:
        namespaceSubscribed

      • tiledbUri

        public ArrayInfo tiledbUri​(java.lang.String tiledbUri)

      • getTiledbUri

        @Nullable
public java.lang.String getTiledbUri()
        uri for access through TileDB cloud
        Returns:
        tiledbUri

      • setTiledbUri

        public void setTiledbUri​(java.lang.String tiledbUri)

      • tags

        public ArrayInfo tags​(java.util.List<java.lang.String> tags)

      • addTagsItem

        public ArrayInfo addTagsItem​(java.lang.String tagsItem)

      • getTags

        @Nullable
public java.util.List<java.lang.String> getTags()
        optional tags for array
        Returns:
        tags

      • setTags

        public void setTags​(java.util.List<java.lang.String> tags)

      • licenseId

        public ArrayInfo licenseId​(java.lang.String licenseId)

      • getLicenseId

        @Nullable
public java.lang.String getLicenseId()
        License identifier from SPDX License List or Custom
        Returns:
        licenseId

      • setLicenseId

        public void setLicenseId​(java.lang.String licenseId)

      • licenseText

        public ArrayInfo licenseText​(java.lang.String licenseText)

      • getLicenseText

        @Nullable
public java.lang.String getLicenseText()
        License text
        Returns:
        licenseText

      • setLicenseText

        public void setLicenseText​(java.lang.String licenseText)

      • readOnly

        public ArrayInfo readOnly​(java.lang.Boolean readOnly)

      • getReadOnly

        @Nullable
public java.lang.Boolean getReadOnly()
        Suggests if the array is in read_only mode
        Returns:
        readOnly

      • setReadOnly

        public void setReadOnly​(java.lang.Boolean readOnly)

      • isFavorite

        public ArrayInfo isFavorite​(java.lang.Boolean isFavorite)

      • getIsFavorite

        @Nullable
public java.lang.Boolean getIsFavorite()
        Indicates whether the array is in user favorites
        Returns:
        isFavorite

      • setIsFavorite

        public void setIsFavorite​(java.lang.Boolean isFavorite)

      • putAdditionalProperty

        public ArrayInfo 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 ArrayInfo

      • fromJson

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

      • toJson

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