Class DocumentVersionMetadata

    • Method Detail

      • id

        public final String id()

        The ID of the version.

        Returns:
        The ID of the version.
      • name

        public final String name()

        The name of the version.

        Returns:
        The name of the version.
      • contentType

        public final String contentType()

        The content type of the document.

        Returns:
        The content type of the document.
      • size

        public final Long size()

        The size of the document, in bytes.

        Returns:
        The size of the document, in bytes.
      • signature

        public final String signature()

        The signature of the document.

        Returns:
        The signature of the document.
      • createdTimestamp

        public final Instant createdTimestamp()

        The timestamp when the document was first uploaded.

        Returns:
        The timestamp when the document was first uploaded.
      • modifiedTimestamp

        public final Instant modifiedTimestamp()

        The timestamp when the document was last uploaded.

        Returns:
        The timestamp when the document was last uploaded.
      • contentCreatedTimestamp

        public final Instant contentCreatedTimestamp()

        The timestamp when the content of the document was originally created.

        Returns:
        The timestamp when the content of the document was originally created.
      • contentModifiedTimestamp

        public final Instant contentModifiedTimestamp()

        The timestamp when the content of the document was modified.

        Returns:
        The timestamp when the content of the document was modified.
      • creatorId

        public final String creatorId()

        The ID of the creator.

        Returns:
        The ID of the creator.
      • thumbnail

        public final Map<DocumentThumbnailType,​String> thumbnail()

        The thumbnail of the document.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasThumbnail() method.

        Returns:
        The thumbnail of the document.
      • hasThumbnail

        public final boolean hasThumbnail()
        For responses, this returns true if the service returned a value for the Thumbnail property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • thumbnailAsStrings

        public final Map<String,​String> thumbnailAsStrings()

        The thumbnail of the document.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasThumbnail() method.

        Returns:
        The thumbnail of the document.
      • source

        public final Map<DocumentSourceType,​String> source()

        The source of the document.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSource() method.

        Returns:
        The source of the document.
      • hasSource

        public final boolean hasSource()
        For responses, this returns true if the service returned a value for the Source property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • sourceAsStrings

        public final Map<String,​String> sourceAsStrings()

        The source of the document.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSource() method.

        Returns:
        The source of the document.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)