Class Document

  • All Implemented Interfaces:
    Serializable

    public class Document
    extends Resource
    PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].
    See Also:
    Serialized Form
    • Method Detail

      • fetcher

        public static DocumentFetcher fetcher​(String pathServiceSid,
                                              String pathSid)
        Create a DocumentFetcher to execute fetch.
        Parameters:
        pathServiceSid - The service_sid
        pathSid - The sid
        Returns:
        DocumentFetcher capable of executing the fetch
      • deleter

        public static DocumentDeleter deleter​(String pathServiceSid,
                                              String pathSid)
        Create a DocumentDeleter to execute delete.
        Parameters:
        pathServiceSid - The service_sid
        pathSid - The sid
        Returns:
        DocumentDeleter capable of executing the delete
      • creator

        public static DocumentCreator creator​(String pathServiceSid)
        Create a DocumentCreator to execute create.
        Parameters:
        pathServiceSid - The service_sid
        Returns:
        DocumentCreator capable of executing the create
      • reader

        public static DocumentReader reader​(String pathServiceSid)
        Create a DocumentReader to execute read.
        Parameters:
        pathServiceSid - The service_sid
        Returns:
        DocumentReader capable of executing the read
      • updater

        public static DocumentUpdater updater​(String pathServiceSid,
                                              String pathSid,
                                              Map<String,​Object> data)
        Create a DocumentUpdater to execute update.
        Parameters:
        pathServiceSid - The service_sid
        pathSid - The sid
        data - The data
        Returns:
        DocumentUpdater capable of executing the update
      • fromJson

        public static Document fromJson​(String json,
                                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        Converts a JSON String into a Document object using the provided ObjectMapper.
        Parameters:
        json - Raw JSON String
        objectMapper - Jackson ObjectMapper
        Returns:
        Document object represented by the provided JSON
      • fromJson

        public static Document fromJson​(InputStream json,
                                        com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        Converts a JSON InputStream into a Document object using the provided ObjectMapper.
        Parameters:
        json - Raw JSON InputStream
        objectMapper - Jackson ObjectMapper
        Returns:
        Document object represented by the provided JSON
      • getSid

        public final String getSid()
        Returns The The sid.
        Returns:
        The sid
      • getUniqueName

        public final String getUniqueName()
        Returns The The unique_name.
        Returns:
        The unique_name
      • getAccountSid

        public final String getAccountSid()
        Returns The The account_sid.
        Returns:
        The account_sid
      • getServiceSid

        public final String getServiceSid()
        Returns The The service_sid.
        Returns:
        The service_sid
      • getUrl

        public final URI getUrl()
        Returns The The url.
        Returns:
        The url
      • getLinks

        public final Map<String,​String> getLinks()
        Returns The The links.
        Returns:
        The links
      • getRevision

        public final String getRevision()
        Returns The The revision.
        Returns:
        The revision
      • getData

        public final Map<String,​Object> getData()
        Returns The The data.
        Returns:
        The data
      • getDateCreated

        public final org.joda.time.DateTime getDateCreated()
        Returns The The date_created.
        Returns:
        The date_created
      • getDateUpdated

        public final org.joda.time.DateTime getDateUpdated()
        Returns The The date_updated.
        Returns:
        The date_updated
      • getCreatedBy

        public final String getCreatedBy()
        Returns The The created_by.
        Returns:
        The created_by
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object