org.openstack4j.openstack.storage.block.domain.CinderVolumeSnapshot Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openstack4j-core Show documentation
OpenStack Java API
There is a newer version: 3.12
package org.openstack4j.openstack.storage.block.domain;

import java.util.Date;
import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonRootName;
import com.google.common.base.MoreObjects;
import org.openstack4j.model.storage.block.Volume.Status;
import org.openstack4j.model.storage.block.VolumeSnapshot;
import org.openstack4j.model.storage.block.builder.VolumeSnapshotBuilder;
import org.openstack4j.openstack.common.ListResult;

/**
 * An OpenStack Volume Snapshot which is a point-in-time copy of a volume.
 *
 * @author Jeremy Unruh
 */
@JsonRootName("snapshot")
public class CinderVolumeSnapshot implements VolumeSnapshot {

    private static final long serialVersionUID = 1L;

    private String id;
    @JsonProperty("name")
    private String name;
    @JsonProperty("display_name")
    private String displayName;
    @JsonProperty("description")
    private String description;
    @JsonProperty("display_description")
    private String displayDescription;
    @JsonProperty("volume_id")
    private String volumeId;
    private Status status;
    @JsonInclude(Include.NON_DEFAULT)
    @JsonProperty("size")
    private Integer size;
    @JsonProperty("created_at")
    private Date created;
    @JsonProperty
    private Boolean force;
    @JsonProperty("metadata")
    private Map metadata;

    /**
     * @return a new Volume Snapshot builder
     */
    public static VolumeSnapshotBuilder builder() {
        return new ConcreteVolumeSnapshotBuilder();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public VolumeSnapshotBuilder toBuilder() {
        return new ConcreteVolumeSnapshotBuilder(this);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getId() {
        return id;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getName() {
        return name;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getDisplayName() {
        return displayName;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getDescription() {
        return description;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getDisplayDescription() {
        return displayDescription;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getVolumeId() {
        return volumeId;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Status getStatus() {
        return status;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getSize() {
        return (size != null) ? size: 0;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Date getCreated() {
        return created;
    }

    /**
     * {@inheritDoc}
     */
    @JsonIgnore
    @Override
    public Map getMetaData() {
        return metadata;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this).omitNullValues()
                .add("id", id).add("name", name).add("description", description).add("volumeId", volumeId)
                .add("status", status).add("created", created).add("force", force).add("size", size).add("metadata", metadata)
                .toString();
    }

    public static class VolumeSnapshots extends ListResult {

        private static final long serialVersionUID = 1L;

        @JsonProperty("snapshots")
        private List snapshots;

        @Override
        protected List value() {
            return snapshots;
        }
    }

    public static class ConcreteVolumeSnapshotBuilder implements VolumeSnapshotBuilder {

        private CinderVolumeSnapshot m;

        ConcreteVolumeSnapshotBuilder() {
            this(new CinderVolumeSnapshot());
        }

        ConcreteVolumeSnapshotBuilder(CinderVolumeSnapshot m) {
            this.m = m;
        }

        @Override
        public VolumeSnapshotBuilder name(String name) {
            m.name = name;
            m.displayName = name;
            return this;
        }

        @Override
        public VolumeSnapshotBuilder description(String description) {
            m.description = description;
            m.displayDescription = description;
            return this;
        }

        @Override
        public VolumeSnapshotBuilder volume(String volumeId) {
            m.volumeId = volumeId;
            return this;
        }

        @Override
        public VolumeSnapshotBuilder force(boolean force) {
            m.force = force;
            return this;
        }

        @Override
        public VolumeSnapshotBuilder metadata(Map metadata) {
            m.metadata = metadata;
            return this;
        }

        @Override
        public VolumeSnapshot build() {
            return m;
        }

        @Override
        public VolumeSnapshotBuilder from(VolumeSnapshot in) {
            m = (CinderVolumeSnapshot) in;
            return this;
        }

    }

}