com.huawei.openstack4j.openstack.image.v2.domain.GlanceImage Maven / Gradle / Ivy

/*******************************************************************************
 * 	Copyright 2016 ContainX and OpenStack4j                                          
 * 	                                                                                 
 * 	Licensed under the Apache License, Version 2.0 (the "License"); you may not      
 * 	use this file except in compliance with the License. You may obtain a copy of    
 * 	the License at                                                                   
 * 	                                                                                 
 * 	    http://www.apache.org/licenses/LICENSE-2.0                                   
 * 	                                                                                 
 * 	Unless required by applicable law or agreed to in writing, software              
 * 	distributed under the License is distributed on an "AS IS" BASIS, WITHOUT        
 * 	WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the         
 * 	License for the specific language governing permissions and limitations under    
 * 	the License.                                                                     
 *******************************************************************************/
/******************************************************************************* 	                                                                                 
 *  Huawei has modified this source file.
 * 	Copyright 2018 Huawei Technologies Co.,Ltd.                                         
 * 	                                                                                 
 * 	Licensed under the Apache License, Version 2.0 (the "License"); you may not      
 * 	use this file except in compliance with the License. You may obtain a copy of    
 * 	the License at                                                                   
 * 	                                                                                 
 * 	    http://www.apache.org/licenses/LICENSE-2.0                                   
 * 	                                                                                 
 * 	Unless required by applicable law or agreed to in writing, software              
 * 	distributed under the License is distributed on an "AS IS" BASIS, WITHOUT        
 * 	WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the         
 * 	License for the specific language governing permissions and limitations under    
 * 	the License.                             
 * *******************************************************************************/
package com.huawei.openstack4j.openstack.image.v2.domain;

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

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.huawei.openstack4j.model.common.builder.BasicResourceBuilder;
import com.huawei.openstack4j.model.image.v2.ContainerFormat;
import com.huawei.openstack4j.model.image.v2.DiskFormat;
import com.huawei.openstack4j.model.image.v2.Image;
import com.huawei.openstack4j.model.image.v2.builder.ImageBuilder;
import com.huawei.openstack4j.openstack.common.ListResult;
import com.google.common.base.MoreObjects;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;

/**
 * A glance v2.0-2.3 image model implementation
 *
 * @author emjburns
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public class GlanceImage implements Image {

    private static final Set RESERVED_KEYS = Sets.newHashSet(Arrays.asList(new String[] {
            "id",
            "name",
            "tags",
            "status",
            "container_format",
            "disk_format",
            "created_at",
            "updated_at",
            "min_disk",
            "min_ram",
            "protected",
            "checksum",
            "owner",
            "visibility",
            "size",
            "locations",
            "direct_url",
            "self",
            "file",
            "schema",
            "architecture",
            "instance_uuid",
            "kernel_id",
            "os_version",
            "os_distro",
            "ramdisk_id",
            "virtual_size" }));

    private static final long serialVersionUID = 1L;

    private String id;

    private String name;
    
    @JsonProperty("deleted")
    private Boolean deleted;
    
    @JsonProperty("__description")
    private String description;
    
    @JsonProperty("virtual_env_type")
    private String virtualEnvType;
    
    @JsonProperty("__image_source_type")
    private String imageSourceType;
    
    @JsonProperty("deleted_at")
    private String deletedAt;
    
    @JsonProperty("__originalimagename")
    private String originalImageName;
    
    @JsonProperty("__productcode")
    private String productCode;
    
    @JsonProperty("__image_size")
    private String imageSize;
    
    @JsonProperty("__data_origin")
    private String dataOrigin;
    
    @JsonProperty("enterprise_project_id")
    private String enterpriseProjectId;
    
    private List tags;

    private ImageStatus status;

    @JsonProperty("container_format")
    private ContainerFormat containerFormat;

    @JsonProperty("disk_format")
    private DiskFormat diskFormat;

    @JsonProperty("created_at")
    private Date createdAt;

    @JsonProperty("updated_at")
    private Date updatedAt;

    @JsonProperty("min_disk")
    private Long minDisk;

    @JsonProperty("min_ram")
    private Long minRam;

    @JsonProperty("protected")
    private Boolean isProtected;

    private String checksum;

    private String owner;

    private ImageVisibility visibility;

    private Long size;

    private List locations;

    @JsonProperty("direct_url")
    private String directUrl;

    private String self;

    private String file;

    private String schema;

    private String architecture;

    @JsonProperty("instance_uuid")
    private String instanceUuid;

    @JsonProperty("kernel_id")
    private String kernelId;

    @JsonProperty("__os_version")
    private String osVersion;

    @JsonProperty("os_distro")
    private String osDistro;

    @JsonProperty("ramdisk_id")
    private String ramdiskId;

    @JsonProperty("virtual_size")
    private Long virtualSize;

    @JsonProperty("__backup_id")
    private String backupId;
    
    @JsonProperty("__isregistered")
    private String isRegistered;
    
    @JsonProperty("__imagetype")
    private String imageType;
    
    @JsonProperty("__os_bit")
    private String osBit;
    
    @JsonProperty("__platform")
    private String platForm;
    
    @JsonProperty("marker")
    private String marker;
    
    @JsonProperty("limit")
    private String limit;
    
    @JsonProperty("sort_key")
    private String sortKey;
    
    @JsonProperty("sort_dir")
    private String sortDir;
    
    @JsonProperty("__os_type")
    private String osType;
    
    @JsonProperty("tag")
    private String tag;
    
    @JsonProperty("member_status")
    private String memberStatus;
    
    @JsonProperty("__support_kvm")
    private String supportKvm;
    
    @JsonProperty("__support_xen")
    private String supportXen;
    
    @JsonProperty("__support_diskintensive")
    private String supportDiskIntensive;
    
    @JsonProperty("__support_highperformance")
    private String supportHighPerformance;
    
    @JsonProperty("__support_xen_gpu_type")
    private String supportXenGpuType;
    
    @JsonProperty("__root_origin")
    private String rootOrigin;
    
    @JsonProperty("__sequence_num")
    private String sequenceNum;
      
    @JsonProperty("properties")
    private String properties;
    
    private Map additionalProperties = Maps.newHashMap();

    /**
     * {@inheritDoc}
     */
    @Override
    public void setName(String name) {
        this.name = name;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setId(String id) {
        this.id = id;
    }

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

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

    /**
     * {@inheritDoc}
     */
    @Override
    public List getTags() {
        return tags;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ContainerFormat getContainerFormat() {
        return containerFormat;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Date getCreatedAt() {
        return createdAt;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public DiskFormat getDiskFormat() {
        return diskFormat;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Date getUpdatedAt() {
        return updatedAt;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Long getMinDisk() {
        return minDisk;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Boolean getIsProtected() {
        return isProtected;
    }

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

    /**
     * {@inheritDoc}
     */
    @Override
    public Long getMinRam() {
        return minRam;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getChecksum() {
        return checksum;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getOwner() {
        return owner;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ImageVisibility getVisibility() {
        return visibility;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Long getSize() {
        return size;
    }

    @Override
    public List getLocations() {
        return locations;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getDirectUrl() {
        return directUrl;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getSelf() {
        return self;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getFile() {
        return file;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getSchema() {
        return schema;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getRamdiskId() {
        return ramdiskId;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getOsDistro() {
        return osDistro;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getOsVersion() {
        return osVersion;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getKernelId() {
        return kernelId;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getInstanceUuid() {
        return instanceUuid;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getArchitecture() {
        return architecture;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Long getVirtualSize() {
        return virtualSize;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public String getBackupId() {
        return backupId;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public String getAdditionalPropertyValue(String key) {
        return additionalProperties.get(key);
    }

    @JsonAnyGetter
    public Map getAdditionalProperties() {
        return additionalProperties;
    }

    @JsonAnySetter
    public void setAdditionalProperty(String key, String value) {
        if (key != null && !RESERVED_KEYS.contains(key)) {
            additionalProperties.put(key, value);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ImageBuilder toBuilder() {
        return new ImageConcreteBuilder(this);
    }

    public static ImageBuilder builder() {
        return new ImageConcreteBuilder();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
                .add("id", id)
                .add("name", name)
                .add("tags", tags)
                .add("imageStatus", status)
                .add("containerFormat", containerFormat)
                .add("diskFormat", diskFormat)
                .add("createdAt", createdAt)
                .add("updatedAt", updatedAt)
                .add("minDisk", minDisk)
                .add("minRam", minRam)
                .add("isProtected", isProtected)
                .add("checksum", checksum)
                .add("owner", owner)
                .add("visibility", visibility)
                .add("size", size)
                .add("locations", locations)
                .add("directUrl", directUrl)
                .add("self", self)
                .add("file", file)
                .add("schema", schema)
                .add("architecture", architecture)
                .add("instanceUuid", instanceUuid)
                .add("kernelId", kernelId)
                .add("osVersion", osVersion)
                .add("osDistro", osDistro)
                .add("ramdiskId", ramdiskId)
                .add("virtualSize", virtualSize)
                .add("deleted", deleted)
                .add("description", description)
                .add("virtualEnvType", virtualEnvType)
                .add("imageSourceType", imageSourceType)
                .add("deletedAt", deletedAt)
                .add("originalImageName", originalImageName)
                .add("productCode", productCode)
                .add("imageSize", imageSize)
                .add("dataOrigin", dataOrigin)
                .add("enterpriseProjectId", enterpriseProjectId)
                .add("isRegistered", isRegistered)
                .add("imageType", imageType)
                .add("osBit", osBit)
                .add("platForm", platForm)
                .add("marker", marker)
                .add("limit", limit)
                .add("sortKey", sortKey)
                .add("sortDir", sortDir)
                .add("osType", osType)
                .add("tag", tag)
                .add("memberStatus", memberStatus)
                .add("supportKvm", supportKvm)
                .add("supportXen", supportXen)
                .add("supportDiskIntensive", supportDiskIntensive)
                .add("supportHighPerformance", supportHighPerformance)
                .add("supportXenGpuType", supportXenGpuType)
                .add("rootOrigin", rootOrigin)
                .add("sequenceNum", sequenceNum)
                .add("properties", properties)
                .toString();
    }


    @JsonInclude(JsonInclude.Include.NON_NULL)
    public static class Images extends ListResult {
        private static final long serialVersionUID = 1L;
        @JsonProperty("images")
        private List images;
        
        @JsonProperty("first")
        private String first;
        
        @JsonProperty("next")
        private String next;
        
        @JsonProperty("schema")
        private String schema;

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

    public static class ImageConcreteBuilder extends BasicResourceBuilder implements ImageBuilder {
        private GlanceImage m;

        ImageConcreteBuilder() {
            this(new GlanceImage());
        }

        ImageConcreteBuilder(GlanceImage m) {
            this.m = m;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder visibility(ImageVisibility visibility) {
            m.visibility = visibility;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder tags(List tags) {
            m.tags = tags;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder containerFormat(ContainerFormat containerFormat) {
            m.containerFormat = containerFormat;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder diskFormat(DiskFormat diskFormat) {
            m.diskFormat = diskFormat;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder minDisk(Long minDisk) {
            m.minDisk = minDisk;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder minRam(Long minRam) {
            m.minRam = minRam;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder isProtected(Boolean isProtected) {
            m.isProtected = isProtected;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder architecture(String architecture) {
            m.architecture = architecture;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder instanceUuid(String instanceUuid) {
            m.instanceUuid = instanceUuid;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder kernelId(String kernelId) {
            m.kernelId = kernelId;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder osVersion(String osVersion) {
            m.osVersion = osVersion;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder osDistro(String osDistro) {
            m.osDistro = osDistro;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder ramdiskId(String ramdiskId) {
            m.ramdiskId = ramdiskId;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder additionalProperty(String key, String value) {
            if (key != null && !RESERVED_KEYS.contains(key)) {
                m.additionalProperties.put(key, value);
            }
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public Image build() {
            return m;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ImageBuilder from(Image in) {
            m = (GlanceImage) in;
            return this;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        protected Image reference() {
            return m;
        }

		@Override
		public ImageBuilder isRegistered(String isRegistered) {
			m.isRegistered = isRegistered;
			return this;
		}

		@Override
		public ImageBuilder imageType(String imageType) {
			m.imageType = imageType;
			return this;
		}

		@Override
		public ImageBuilder virtualEnvType(String virtualEnvType) {
			m.virtualEnvType = virtualEnvType;
			return this;
		}

		@Override
		public ImageBuilder imageSourceType(String imageSourceType) {
			m.imageSourceType = imageSourceType;
			return this;
		}

		@Override
		public ImageBuilder imageSize(String imageSize) {
			m.imageSize = imageSize;
			return this;
		}

		@Override
		public ImageBuilder osBit(String osBit) {
			m.osBit = osBit;
			return this;
		}

		@Override
		public ImageBuilder platForm(String platForm) {
			m.platForm = platForm;
			return this;
		}

		@Override
		public ImageBuilder osType(String osType) {
			m.osType = osType;
			return this;
		}

		@Override
		public ImageBuilder properties(String properties) {
			m.properties = properties;
			return this;
		}
    }

	@Override
	public Boolean getDeleted() {
		return deleted;
	}

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

	@Override
	public String getVirtualEnvType() {
		return virtualEnvType;
	}

	@Override
	public String getImageSourceType() {
		return imageSourceType;
	}

	@Override
	public String getDeletedAt() {
		return deletedAt;
	}

	@Override
	public String getOriginalImageName() {
		return originalImageName;
	}

	@Override
	public String getProductCode() {
		return productCode;
	}

	@Override
	public String getImageSize() {
		return imageSize;
	}

	@Override
	public String getDataOrigin() {
		return dataOrigin;
	}

	@Override
	public String getEnterpriseProjectId() {
		return enterpriseProjectId;
	}

	@Override
	public String getIsRegistered() {
		return isRegistered;
	}

	@Override
	public String getImageType() {
		return imageType;
	}

	@Override
	public String getOsBit() {
		return osBit;
	}

	@Override
	public String getPlatForm() {
		return platForm;
	}

	@Override
	public String getOsType() {
		return osType;
	}

	@Override
	public String getSupportKvm() {
		return supportKvm;
	}

	@Override
	public String getSupportXen() {
		return supportXen;
	}

	@Override
	public String getSupportDiskIntensive() {
		return supportDiskIntensive;
	}

	@Override
	public String getSupportHighPerformance() {
		return supportHighPerformance;
	}

	@Override
	public String getSupportXenGpuType() {
		return supportXenGpuType;
	}

	@Override
	public String getSequenceNum() {
		return sequenceNum;
	}
}