Package com.twilio.rest.sync.v1.service

Class Document

  • All Implemented Interfaces:
    Serializable
    public class Document
extends Resource
    PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
    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)
        Create a DocumentUpdater to execute update.
        Parameters:
        pathServiceSid - The service_sid
        pathSid - The sid
        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 unique 34-character SID identifier of the Document..
        Returns:
        The unique 34-character SID identifier of the Document.

      • getUniqueName

        public final String getUniqueName()
        Returns The The unique and addressable name of this Document..
        Returns:
        The unique and addressable name of this Document.

      • getAccountSid

        public final String getAccountSid()
        Returns The The unique SID identifier of the Twilio Account..
        Returns:
        The unique SID identifier of the Twilio Account.

      • getServiceSid

        public final String getServiceSid()
        Returns The The unique SID identifier of the Service Instance that hosts this Document..
        Returns:
        The unique SID identifier of the Service Instance that hosts this Document.

      • getUrl

        public final URI getUrl()
        Returns The The absolute URL for this Document..
        Returns:
        The absolute URL for this Document.

      • getLinks

        public final Map<String,​String> getLinks()
        Returns The A dictionary of URL links to nested resources of this Document..
        Returns:
        A dictionary of URL links to nested resources of this Document.

      • getRevision

        public final String getRevision()
        Returns The Contains the current revision of this Document, represented by a string identifier..
        Returns:
        Contains the current revision of this Document, represented by a string identifier.

      • getData

        public final Map<String,​Object> getData()
        Returns The Contains arbitrary user-defined, schema-less data that this Document stores, represented by a JSON object, up to 16KB..
        Returns:
        Contains arbitrary user-defined, schema-less data that this Document stores, represented by a JSON object, up to 16KB.

      • getDateExpires

        public final org.joda.time.DateTime getDateExpires()
        Returns The Contains the date this Document expires and gets deleted automatically..
        Returns:
        Contains the date this Document expires and gets deleted automatically.

      • getDateCreated

        public final org.joda.time.DateTime getDateCreated()
        Returns The The date this Document was created, given in UTC ISO 8601 format..
        Returns:
        The date this Document was created, given in UTC ISO 8601 format.

      • getDateUpdated

        public final org.joda.time.DateTime getDateUpdated()
        Returns The Specifies the date this Document was last updated, given in UTC ISO 8601 format..
        Returns:
        Specifies the date this Document was last updated, given in UTC ISO 8601 format.

      • getCreatedBy

        public final String getCreatedBy()
        Returns The The identity of the Document creator..
        Returns:
        The identity of the Document creator.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object