All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.twilio.rest.sync.v1.service.syncmap.SyncMapItem Maven / Gradle / Ivy

There is a newer version: 7.47.6
Show newest version
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.rest.sync.v1.service.syncmap;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.MoreObjects;
import com.twilio.base.Resource;
import com.twilio.converter.Converter;
import com.twilio.converter.DateConverter;
import com.twilio.converter.Promoter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
import org.joda.time.DateTime;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.util.Map;
import java.util.Objects;

/**
 * PLEASE NOTE that this class contains beta products that are subject to
 * change. Use them with caution.
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class SyncMapItem extends Resource {
    private static final long serialVersionUID = 280430240185290L;

    public enum QueryResultOrder {
        ASC("asc"),
        DESC("desc");

        private final String value;

        private QueryResultOrder(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }

        /**
         * Generate a QueryResultOrder from a string.
         * @param value string value
         * @return generated QueryResultOrder
         */
        @JsonCreator
        public static QueryResultOrder forValue(final String value) {
            return Promoter.enumFromString(value, QueryResultOrder.values());
        }
    }

    public enum QueryFromBoundType {
        INCLUSIVE("inclusive"),
        EXCLUSIVE("exclusive");

        private final String value;

        private QueryFromBoundType(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }

        /**
         * Generate a QueryFromBoundType from a string.
         * @param value string value
         * @return generated QueryFromBoundType
         */
        @JsonCreator
        public static QueryFromBoundType forValue(final String value) {
            return Promoter.enumFromString(value, QueryFromBoundType.values());
        }
    }

    /**
     * Create a SyncMapItemFetcher to execute fetch.
     * 
     * @param pathServiceSid The service_sid
     * @param pathMapSid The map_sid
     * @param pathKey The key
     * @return SyncMapItemFetcher capable of executing the fetch
     */
    public static SyncMapItemFetcher fetcher(final String pathServiceSid, 
                                             final String pathMapSid, 
                                             final String pathKey) {
        return new SyncMapItemFetcher(pathServiceSid, pathMapSid, pathKey);
    }

    /**
     * Create a SyncMapItemDeleter to execute delete.
     * 
     * @param pathServiceSid The service_sid
     * @param pathMapSid The map_sid
     * @param pathKey The key
     * @return SyncMapItemDeleter capable of executing the delete
     */
    public static SyncMapItemDeleter deleter(final String pathServiceSid, 
                                             final String pathMapSid, 
                                             final String pathKey) {
        return new SyncMapItemDeleter(pathServiceSid, pathMapSid, pathKey);
    }

    /**
     * Create a SyncMapItemCreator to execute create.
     * 
     * @param pathServiceSid The service_sid
     * @param pathMapSid The map_sid
     * @param key The unique user-defined key of this Map Item.
     * @param data Contains arbitrary user-defined, schema-less data that this Map
     *             Item stores, represented by a JSON object, up to 16KB.
     * @return SyncMapItemCreator capable of executing the create
     */
    public static SyncMapItemCreator creator(final String pathServiceSid, 
                                             final String pathMapSid, 
                                             final String key, 
                                             final Map data) {
        return new SyncMapItemCreator(pathServiceSid, pathMapSid, key, data);
    }

    /**
     * Create a SyncMapItemReader to execute read.
     * 
     * @param pathServiceSid The service_sid
     * @param pathMapSid The map_sid
     * @return SyncMapItemReader capable of executing the read
     */
    public static SyncMapItemReader reader(final String pathServiceSid, 
                                           final String pathMapSid) {
        return new SyncMapItemReader(pathServiceSid, pathMapSid);
    }

    /**
     * Create a SyncMapItemUpdater to execute update.
     * 
     * @param pathServiceSid The service_sid
     * @param pathMapSid The map_sid
     * @param pathKey The key
     * @return SyncMapItemUpdater capable of executing the update
     */
    public static SyncMapItemUpdater updater(final String pathServiceSid, 
                                             final String pathMapSid, 
                                             final String pathKey) {
        return new SyncMapItemUpdater(pathServiceSid, pathMapSid, pathKey);
    }

    /**
     * Converts a JSON String into a SyncMapItem object using the provided
     * ObjectMapper.
     * 
     * @param json Raw JSON String
     * @param objectMapper Jackson ObjectMapper
     * @return SyncMapItem object represented by the provided JSON
     */
    public static SyncMapItem fromJson(final String json, final ObjectMapper objectMapper) {
        // Convert all checked exceptions to Runtime
        try {
            return objectMapper.readValue(json, SyncMapItem.class);
        } catch (final JsonMappingException | JsonParseException e) {
            throw new ApiException(e.getMessage(), e);
        } catch (final IOException e) {
            throw new ApiConnectionException(e.getMessage(), e);
        }
    }

    /**
     * Converts a JSON InputStream into a SyncMapItem object using the provided
     * ObjectMapper.
     * 
     * @param json Raw JSON InputStream
     * @param objectMapper Jackson ObjectMapper
     * @return SyncMapItem object represented by the provided JSON
     */
    public static SyncMapItem fromJson(final InputStream json, final ObjectMapper objectMapper) {
        // Convert all checked exceptions to Runtime
        try {
            return objectMapper.readValue(json, SyncMapItem.class);
        } catch (final JsonMappingException | JsonParseException e) {
            throw new ApiException(e.getMessage(), e);
        } catch (final IOException e) {
            throw new ApiConnectionException(e.getMessage(), e);
        }
    }

    private final String key;
    private final String accountSid;
    private final String serviceSid;
    private final String mapSid;
    private final URI url;
    private final String revision;
    private final Map data;
    private final DateTime dateExpires;
    private final DateTime dateCreated;
    private final DateTime dateUpdated;
    private final String createdBy;

    @JsonCreator
    private SyncMapItem(@JsonProperty("key")
                        final String key, 
                        @JsonProperty("account_sid")
                        final String accountSid, 
                        @JsonProperty("service_sid")
                        final String serviceSid, 
                        @JsonProperty("map_sid")
                        final String mapSid, 
                        @JsonProperty("url")
                        final URI url, 
                        @JsonProperty("revision")
                        final String revision, 
                        @JsonProperty("data")
                        final Map data, 
                        @JsonProperty("date_expires")
                        final String dateExpires, 
                        @JsonProperty("date_created")
                        final String dateCreated, 
                        @JsonProperty("date_updated")
                        final String dateUpdated, 
                        @JsonProperty("created_by")
                        final String createdBy) {
        this.key = key;
        this.accountSid = accountSid;
        this.serviceSid = serviceSid;
        this.mapSid = mapSid;
        this.url = url;
        this.revision = revision;
        this.data = data;
        this.dateExpires = DateConverter.iso8601DateTimeFromString(dateExpires);
        this.dateCreated = DateConverter.iso8601DateTimeFromString(dateCreated);
        this.dateUpdated = DateConverter.iso8601DateTimeFromString(dateUpdated);
        this.createdBy = createdBy;
    }

    /**
     * Returns The The unique user-defined key of this Map Item..
     * 
     * @return The unique user-defined key of this Map Item.
     */
    public final String getKey() {
        return this.key;
    }

    /**
     * Returns The The unique SID identifier of the Twilio Account..
     * 
     * @return The unique SID identifier of the Twilio Account.
     */
    public final String getAccountSid() {
        return this.accountSid;
    }

    /**
     * Returns The The unique SID identifier of the Service Instance that hosts this
     * Map object..
     * 
     * @return The unique SID identifier of the Service Instance that hosts this
     *         Map object.
     */
    public final String getServiceSid() {
        return this.serviceSid;
    }

    /**
     * Returns The The unique 34-character SID identifier of the Map containing this
     * Item..
     * 
     * @return The unique 34-character SID identifier of the Map containing this
     *         Item.
     */
    public final String getMapSid() {
        return this.mapSid;
    }

    /**
     * Returns The The absolute URL for this Map..
     * 
     * @return The absolute URL for this Map.
     */
    public final URI getUrl() {
        return this.url;
    }

    /**
     * Returns The Contains the current revision of this Map, represented by a
     * string identifier..
     * 
     * @return Contains the current revision of this Map, represented by a string
     *         identifier.
     */
    public final String getRevision() {
        return this.revision;
    }

    /**
     * Returns The Contains arbitrary user-defined, schema-less data that this Map
     * Item stores, represented by a JSON object, up to 16KB..
     * 
     * @return Contains arbitrary user-defined, schema-less data that this Map Item
     *         stores, represented by a JSON object, up to 16KB.
     */
    public final Map getData() {
        return this.data;
    }

    /**
     * Returns The Contains the date this Map expires and gets deleted
     * automatically..
     * 
     * @return Contains the date this Map expires and gets deleted automatically.
     */
    public final DateTime getDateExpires() {
        return this.dateExpires;
    }

    /**
     * Returns The The date this Map was created, given in UTC ISO 8601 format..
     * 
     * @return The date this Map was created, given in UTC ISO 8601 format.
     */
    public final DateTime getDateCreated() {
        return this.dateCreated;
    }

    /**
     * Returns The Specifies the date this Map was last updated, given in UTC ISO
     * 8601 format..
     * 
     * @return Specifies the date this Map was last updated, given in UTC ISO 8601
     *         format.
     */
    public final DateTime getDateUpdated() {
        return this.dateUpdated;
    }

    /**
     * Returns The The identity of the Map creator..
     * 
     * @return The identity of the Map creator.
     */
    public final String getCreatedBy() {
        return this.createdBy;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }

        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        SyncMapItem other = (SyncMapItem) o;

        return Objects.equals(key, other.key) && 
               Objects.equals(accountSid, other.accountSid) && 
               Objects.equals(serviceSid, other.serviceSid) && 
               Objects.equals(mapSid, other.mapSid) && 
               Objects.equals(url, other.url) && 
               Objects.equals(revision, other.revision) && 
               Objects.equals(data, other.data) && 
               Objects.equals(dateExpires, other.dateExpires) && 
               Objects.equals(dateCreated, other.dateCreated) && 
               Objects.equals(dateUpdated, other.dateUpdated) && 
               Objects.equals(createdBy, other.createdBy);
    }

    @Override
    public int hashCode() {
        return Objects.hash(key,
                            accountSid,
                            serviceSid,
                            mapSid,
                            url,
                            revision,
                            data,
                            dateExpires,
                            dateCreated,
                            dateUpdated,
                            createdBy);
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
                          .add("key", key)
                          .add("accountSid", accountSid)
                          .add("serviceSid", serviceSid)
                          .add("mapSid", mapSid)
                          .add("url", url)
                          .add("revision", revision)
                          .add("data", data)
                          .add("dateExpires", dateExpires)
                          .add("dateCreated", dateCreated)
                          .add("dateUpdated", dateUpdated)
                          .add("createdBy", createdBy)
                          .toString();
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy