Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */
package com.microsoft.azure.management.appservice;

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Beta.SinceVersion;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent;
import com.microsoft.azure.management.resources.fluentcore.model.Executable;
import org.joda.time.DateTime;

A client-side representation allowing user to deploy to a web app through web deployment (MSDeploy).
/**
 * A client-side representation allowing user to deploy to a web app through web deployment (MSDeploy).
 */
@Fluent(ContainerName = "/Microsoft.Azure.Management.AppService.Fluent")
@Beta(SinceVersion.V1_2_0)
public interface WebDeployment extends Executable<WebDeployment>,
        HasParent<WebAppBase> {
    
Returns:
username of the deployer/**
     * @return username of the deployer
     */
    String deployer();

    
Returns:
the start time of the deploy operation/**
     * @return the start time of the deploy operation
     */
    DateTime startTime();

    
Returns:
the end time of the deploy operation/**
     * @return the end time of the deploy operation
     */
    DateTime endTime();

    
Returns:
whether the deployment operation has completed/**
     * @return whether the deployment operation has completed
     */
    boolean complete();

    
The entirety of web deployment parameters definition.
/**
     * The entirety of web deployment parameters definition.
     */
    interface Definition extends
            DefinitionStages.WithPackageUri,
            DefinitionStages.WithExecute {
    }


    
Grouping of web deployment definition stages.
/**
     * Grouping of web deployment definition stages.
     */
    interface DefinitionStages {
        
The first stage of a web deployment definition.
/**
         * The first stage of a web deployment definition.
         */
        interface WithPackageUri {
            
Specifies the zipped package to deploy.
Params:
packageUri – the URL to the package. It can be a publicly available link to
                  the package zip, or an Azure Storage object with a SAS token
Returns:
the next definition stage/**
             * Specifies the zipped package to deploy.
             *
             * @param packageUri the URL to the package. It can be a publicly available link to
             *                   the package zip, or an Azure Storage object with a SAS token
             * @return the next definition stage
             */
            WithExecute withPackageUri(String packageUri);
        }

        
A web deployment definition stage allowing specifying whether to delete existing deployments.
/**
         * A web deployment definition stage allowing specifying whether to delete existing deployments.
         */
        interface WithExistingDeploymentsDeleted {
            
Specifies whether existing deployed files on the web app should be deleted.
Params:
deleteExisting – if set to true, all files on the web app will be deleted. Default is false.
Returns:
the next definition stage/**
             * Specifies whether existing deployed files on the web app should be deleted.
             *
             * @param deleteExisting if set to true, all files on the web app will be deleted. Default is false.
             * @return the next definition stage
             */
            WithExecute withExistingDeploymentsDeleted(boolean deleteExisting);
        }

        
A web deployment definition stage allowing adding more packages.
/**
         * A web deployment definition stage allowing adding more packages.
         */
        interface WithAddOnPackage {
            
Adds an extra package to the deployment.
Params:
packageUri – the URL to the package. It can be a publicly available link to
                  the package zip, or an Azure Storage object with a SAS token
Returns:
the next definition stage/**
             * Adds an extra package to the deployment.
             *
             * @param packageUri the URL to the package. It can be a publicly available link to
             *                   the package zip, or an Azure Storage object with a SAS token
             * @return the next definition stage
             */
            WithExecute withAddOnPackage(String packageUri);
        }

        
A web deployment definition stage allowing specifying parameters.
/**
         * A web deployment definition stage allowing specifying parameters.
         */
        interface WithSetParameters {
            
Specifies the XML file containing the parameters.
Params:
fileUri – the XML file's URI
Returns:
the next definition stage/**
             * Specifies the XML file containing the parameters.
             *
             * @param fileUri the XML file's URI
             * @return the next definition stage
             */
            WithExecute withSetParametersXmlFile(String fileUri);

            
Adds a parameter for the deployment.
Params:
name – name of the parameter
value – the value of the parameter
Returns:
the next definition stage/**
             * Adds a parameter for the deployment.
             * @param name name of the parameter
             * @param value the value of the parameter
             * @return the next definition stage
             */
            WithExecute withSetParameter(String name, String value);
        }

        
The stage of the definition which contains all the minimum required inputs for
the resource to be created, but also allows
for any other optional settings to be specified.
/**
         * The stage of the definition which contains all the minimum required inputs for
         * the resource to be created, but also allows
         * for any other optional settings to be specified.
         */
        interface WithExecute extends
                Executable<WebDeployment>,
                WithExistingDeploymentsDeleted,
                WithAddOnPackage,
                WithSetParameters {
        }
    }
}