Class Key

  • All Implemented Interfaces:
    Serializable

    public class Key
    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 KeyFetcher fetcher​(String pathFleetSid,
                                         String pathSid)
        Create a KeyFetcher to execute fetch.
        Parameters:
        pathFleetSid - The fleet_sid
        pathSid - A string that uniquely identifies the Key.
        Returns:
        KeyFetcher capable of executing the fetch
      • deleter

        public static KeyDeleter deleter​(String pathFleetSid,
                                         String pathSid)
        Create a KeyDeleter to execute delete.
        Parameters:
        pathFleetSid - The fleet_sid
        pathSid - A string that uniquely identifies the Key.
        Returns:
        KeyDeleter capable of executing the delete
      • creator

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

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

        public static KeyUpdater updater​(String pathFleetSid,
                                         String pathSid)
        Create a KeyUpdater to execute update.
        Parameters:
        pathFleetSid - The fleet_sid
        pathSid - A string that uniquely identifies the Key.
        Returns:
        KeyUpdater capable of executing the update
      • fromJson

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

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

        public final String getSid()
        Returns The A string that uniquely identifies this Key..
        Returns:
        A string that uniquely identifies this Key.
      • getUrl

        public final URI getUrl()
        Returns The URL of this Key..
        Returns:
        URL of this Key.
      • getFriendlyName

        public final String getFriendlyName()
        Returns The A human readable description for this Key..
        Returns:
        A human readable description for this Key.
      • getFleetSid

        public final String getFleetSid()
        Returns The The unique identifier of the Fleet..
        Returns:
        The unique identifier of the Fleet.
      • getAccountSid

        public final String getAccountSid()
        Returns The The unique SID that identifies this Account..
        Returns:
        The unique SID that identifies this Account.
      • getDeviceSid

        public final String getDeviceSid()
        Returns The The unique identifier of a mapped Device..
        Returns:
        The unique identifier of a mapped Device.
      • getSecret

        public final String getSecret()
        Returns The The key secret..
        Returns:
        The key secret.
      • getDateCreated

        public final org.joda.time.DateTime getDateCreated()
        Returns The The date this Key credential was created..
        Returns:
        The date this Key credential was created.
      • getDateUpdated

        public final org.joda.time.DateTime getDateUpdated()
        Returns The The date this Key credential was updated..
        Returns:
        The date this Key credential was updated.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object