api/src/main/java/org/apache/cloudstack/api/response/ExtractResponse.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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 org.apache.cloudstack.api.response;

import java.util.Date;

import com.google.gson.annotations.SerializedName;

import org.apache.cloudstack.api.ApiConstants;
import org.apache.cloudstack.api.BaseResponse;

import com.cloud.serializer.Param;

public class ExtractResponse extends BaseResponse {
    @SerializedName(ApiConstants.ID)
    @Param(description = "the id of extracted object")
    private String id;

    @SerializedName(ApiConstants.NAME)
    @Param(description = "the name of the extracted object")
    private String name;

    @SerializedName("extractId")
    @Param(description = "the upload id of extracted object")
    private String uploadId;

    @SerializedName("uploadpercentage")
    @Param(description = "the percentage of the entity uploaded to the specified location")
    private Integer uploadPercent;

    @SerializedName("status")
    @Param(description = "the status of the extraction")
    private String status;

    @SerializedName("accountid")
    @Param(description = "the account id to which the extracted object belongs")
    private String accountId;

    @SerializedName("resultstring")
    @Param(includeInApiDoc = false)
    private String resultString;

    @SerializedName(ApiConstants.CREATED)
    @Param(description = "the time and date the object was created")
    private Date createdDate;

    @SerializedName(ApiConstants.STATE)
    @Param(description = "the state of the extracted object")
    private String state;

    @SerializedName("storagetype")
    @Param(description = "type of the storage")
    private String storageType;

    @SerializedName(ApiConstants.ZONE_ID)
    @Param(description = "zone ID the object was extracted from")
    private String zoneId;

    @SerializedName(ApiConstants.ZONE_NAME)
    @Param(description = "zone name the object was extracted from")
    private String zoneName;

    @SerializedName("extractMode")
    @Param(description = "the mode of extraction - upload or download")
    private String mode;

    @SerializedName(ApiConstants.URL)
    @Param(description = "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded")
    private String url;

    public ExtractResponse() {
    }

    public ExtractResponse(String typeId, String typeName, String accountId, String state, String uploadId) {
        this.id = typeId;
        this.name = typeName;
        this.accountId = accountId;
        this.state = state;
        this.uploadId = uploadId;
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getUploadId() {
        return uploadId;
    }

    public void setUploadId(String uploadId) {
        this.uploadId = uploadId;
    }

    public Integer getUploadPercent() {
        return uploadPercent;
    }

    public void setUploadPercent(int uploadPercent) {
        this.uploadPercent = uploadPercent;
    }

    public String getUploadStatus() {
        return status;
    }

    public void setUploadStatus(String status) {
        this.status = status;
    }

    public String getAccountId() {
        return accountId;
    }

    public void setAccountId(String accountId) {
        this.accountId = accountId;
    }

    public String getResultString() {
        return resultString;
    }

    public void setResultString(String resultString) {
        this.resultString = resultString;
    }

    public Date getCreatedDate() {
        return createdDate;
    }

    public void setCreatedDate(Date createdDate) {
        this.createdDate = createdDate;
    }

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }

    public String getStorageType() {
        return storageType;
    }

    public void setStorageType(String storageType) {
        this.storageType = storageType;
    }

    public String getZoneId() {
        return zoneId;
    }

    public void setZoneId(String zoneId) {
        this.zoneId = zoneId;
    }

    public String getZoneName() {
        return zoneName;
    }

    public void setZoneName(String zoneName) {
        this.zoneName = zoneName;
    }

    public String getMode() {
        return mode;
    }

    public void setMode(String mode) {
        this.mode = mode;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }
}