core/src/main/java/com/cloud/agent/api/MigrateVmToPoolCommand.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 com.cloud.agent.api;

import com.cloud.agent.api.to.VolumeTO;

import java.util.Collection;

/**
 * used to tell the agent to migrate a vm to a different primary storage pool.
 * It is for now only implemented on Vmware and is supposed to work irrespective of whether the VM is started or not.
 *
 */
public class MigrateVmToPoolCommand extends Command {
    private Collection<VolumeTO> volumes;
    private String vmName;
    private String destinationPool;
    private boolean executeInSequence = false;

    protected MigrateVmToPoolCommand() {
    }

    /**
     *
     * @param vmName the name of the VM to migrate
     * @param volumes used to supply feedback on vmware generated names
     * @param destinationPool the primary storage pool to migrate the VM to
     * @param executeInSequence
     */
    public MigrateVmToPoolCommand(String vmName, Collection<VolumeTO> volumes, String destinationPool, boolean executeInSequence) {
        this.vmName = vmName;
        this.volumes = volumes;
        this.destinationPool = destinationPool;
        this.executeInSequence = executeInSequence;
    }

    public Collection<VolumeTO> getVolumes() {
        return volumes;
    }

    public String getDestinationPool() {
        return destinationPool;
    }

    public String getVmName() {
        return vmName;
    }

    @Override
    public boolean executeInSequence() {
        return executeInSequence;
    }

}