api/src/main/java/org/apache/cloudstack/api/command/admin/storage/MigrateSecondaryStorageDataCmd.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.command.admin.storage;

import java.util.List;

import org.apache.cloudstack.acl.RoleType;
import org.apache.cloudstack.api.APICommand;
import org.apache.cloudstack.api.ApiCommandResourceType;
import org.apache.cloudstack.api.ApiConstants;
import org.apache.cloudstack.api.BaseAsyncCmd;
import org.apache.cloudstack.api.Parameter;
import org.apache.cloudstack.api.response.ImageStoreResponse;
import org.apache.cloudstack.api.response.MigrationResponse;
import org.apache.cloudstack.context.CallContext;

import com.cloud.event.EventTypes;

@APICommand(name = "migrateSecondaryStorageData",
        description = "migrates data objects from one secondary storage to destination image store(s)",
        responseObject = MigrationResponse.class,
        requestHasSensitiveInfo = false,
        responseHasSensitiveInfo = false,
        since = "4.15.0",
        authorized = {RoleType.Admin})
public class MigrateSecondaryStorageDataCmd extends BaseAsyncCmd {



    /////////////////////////////////////////////////////
    //////////////// API parameters /////////////////////
    /////////////////////////////////////////////////////

    @Parameter(name = ApiConstants.SRC_POOL,
            type = CommandType.UUID,
            entityType = ImageStoreResponse.class,
            description = "id of the image store from where the data is to be migrated",
    required = true)
    private Long id;

    @Parameter(name = ApiConstants.DEST_POOLS,
    type = CommandType.LIST,
    collectionType = CommandType.UUID,
    entityType = ImageStoreResponse.class,
    description = "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated",
    required = true)
    private List<Long> migrateTo;

    @Parameter(name = ApiConstants.MIGRATION_TYPE,
    type = CommandType.STRING,
    description = "Balance: if you want data to be distributed evenly among the destination stores, " +
            "Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete")
    private String migrationType;

    /////////////////////////////////////////////////////
    /////////////////// Accessors ///////////////////////
    /////////////////////////////////////////////////////

    public Long getId() {
        return id;
    }

    public List<Long> getMigrateTo() {
        return migrateTo;
    }

    public String getMigrationType() {
        return migrationType;
    }

    @Override
    public String getEventType() {
        return EventTypes.EVENT_IMAGE_STORE_DATA_MIGRATE;
    }

    @Override
    public String getEventDescription() {
        return "Attempting to migrate files/data objects ";
    }

    @Override
    public void execute()  {
        MigrationResponse response = _imageStoreService.migrateData(this);
        response.setObjectName("imagestore");
        this.setResponseObject(response);
        CallContext.current().setEventDetails(response.getMessage());
    }

    @Override
    public long getEntityOwnerId() {
        return CallContext.current().getCallingAccountId();
    }

    @Override
    public Long getApiResourceId() {
        return getId();
    }

    @Override
    public ApiCommandResourceType getApiResourceType() {
        return ApiCommandResourceType.ImageStore;
    }
}