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.ResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import rx.Completable;

import java.io.File;
import java.io.InputStream;

An immutable client-side representation of an Azure Web App.
/**
 * An immutable client-side representation of an Azure Web App.
 */
@Fluent(ContainerName = "/Microsoft.Azure.Management.AppService.Fluent")
@Beta
public interface WebApp extends
        WebAppBase,
        SupportsOneDeploy,
        Refreshable<WebApp>,
        Updatable<WebApp.Update> {
    
Returns:
the entry point to deployment slot management API under the web app/**
     * @return the entry point to deployment slot management API under the web app
     */
    DeploymentSlots deploymentSlots();

    
Deploys a WAR file onto the Azure specialized Tomcat on this web app.
Params:
warFile – the WAR file to upload/**
     * Deploys a WAR file onto the Azure specialized Tomcat on this web app.
     * @param warFile the WAR file to upload
     */
    @Beta(SinceVersion.V1_7_0)
    void warDeploy(File warFile);

    
Deploys a WAR file onto the Azure specialized Tomcat on this web app.
Params:
warFile – the WAR file to upload
Returns:
a completable of the operation/**
     * Deploys a WAR file onto the Azure specialized Tomcat on this web app.
     * @param warFile the WAR file to upload
     * @return a completable of the operation
     */
    @Beta(SinceVersion.V1_7_0)
    Completable warDeployAsync(File warFile);

    
Deploys a WAR file onto the Azure specialized Tomcat on this web app.
Params:
warFile – the WAR file to upload/**
     * Deploys a WAR file onto the Azure specialized Tomcat on this web app.
     * @param warFile the WAR file to upload
     */
    @Beta(SinceVersion.V1_7_0)
    void warDeploy(InputStream warFile);

    
Deploys a WAR file onto the Azure specialized Tomcat on this web app.
Params:
warFile – the WAR file to upload
Returns:
a completable of the operation/**
     * Deploys a WAR file onto the Azure specialized Tomcat on this web app.
     * @param warFile the WAR file to upload
     * @return a completable of the operation
     */
    @Beta(SinceVersion.V1_7_0)
    Completable warDeployAsync(InputStream warFile);

    
Deploys a WAR file onto the Azure specialized Tomcat on this web app.
Params:
warFile – the WAR file to upload
appName – the name of the app, default to "ROOT" when not provided/**
     * Deploys a WAR file onto the Azure specialized Tomcat on this web app.
     * @param warFile the WAR file to upload
     * @param appName the name of the app, default to "ROOT" when not provided
     */
    @Beta(SinceVersion.V1_7_0)
    void warDeploy(File warFile, String appName);

    
Deploys a WAR file onto the Azure specialized Tomcat on this web app.
Params:
warFile – the WAR file to upload
appName – the name of the app, default to "ROOT" when not provided
Returns:
a completable of the operation/**
     * Deploys a WAR file onto the Azure specialized Tomcat on this web app.
     * @param warFile the WAR file to upload
     * @param appName the name of the app, default to "ROOT" when not provided
     * @return a completable of the operation
     */
    @Beta(SinceVersion.V1_7_0)
    Completable warDeployAsync(File warFile, String appName);

    
Deploys a WAR file onto the Azure specialized Tomcat on this web app.
Params:
warFile – the WAR file to upload
appName – the name of the app, default to "ROOT" when not provided/**
     * Deploys a WAR file onto the Azure specialized Tomcat on this web app.
     * @param warFile the WAR file to upload
     * @param appName the name of the app, default to "ROOT" when not provided
     */
    @Beta(SinceVersion.V1_7_0)
    void warDeploy(InputStream warFile, String appName);

    
Deploys a WAR file onto the Azure specialized Tomcat on this web app.
Params:
warFile – the WAR file to upload
appName – the name of the app, default to "ROOT" when not provided
Returns:
a completable of the operation/**
     * Deploys a WAR file onto the Azure specialized Tomcat on this web app.
     * @param warFile the WAR file to upload
     * @param appName the name of the app, default to "ROOT" when not provided
     * @return a completable of the operation
     */
    @Beta(SinceVersion.V1_7_0)
    Completable warDeployAsync(InputStream warFile, String appName);

    /**************************************************************
     * Fluent interfaces to provision a Web App
     **************************************************************/

    
Container interface for all the definitions that need to be implemented.
/**
     * Container interface for all the definitions that need to be implemented.
     */
    interface Definition extends
            DefinitionStages.Blank,
            DefinitionStages.NewAppServicePlanWithGroup,
            DefinitionStages.WithNewAppServicePlan,
            DefinitionStages.WithDockerContainerImage,
            DefinitionStages.WithCredentials,
            DefinitionStages.WithStartUpCommand,
            DefinitionStages.WithCreate {
    }

    
Grouping of all the web app definition stages.
/**
     * Grouping of all the web app definition stages.
     */
    interface DefinitionStages {
        
The first stage of the web app definition.
/**
         * The first stage of the web app definition.
         */
        interface Blank extends DefinitionWithRegion<NewAppServicePlanWithGroup> {
            
Uses an existing app service plan for the web app.
Params:
appServicePlan – the existing app service plan
Returns:
the next stage of the definition/**
             * Uses an existing app service plan for the web app.
             * @param appServicePlan the existing app service plan
             * @return the next stage of the definition
             */
            ExistingWindowsPlanWithGroup withExistingWindowsPlan(AppServicePlan appServicePlan);

            
Uses an existing app service plan for the web app.
Params:
appServicePlan – the existing app service plan
Returns:
the next stage of the definition/**
             * Uses an existing app service plan for the web app.
             * @param appServicePlan the existing app service plan
             * @return the next stage of the definition
             */
            ExistingLinuxPlanWithGroup withExistingLinuxPlan(AppServicePlan appServicePlan);
        }

        
A web app definition allowing resource group to be specified when an existing app service plan is used.
/**
         * A web app definition allowing resource group to be specified when an existing app service plan is used.
         */
        interface NewAppServicePlanWithGroup extends GroupableResource.DefinitionStages.WithGroup<WithNewAppServicePlan> {
        }

        
A web app definition allowing resource group to be specified when a new app service plan is to be created.
/**
         * A web app definition allowing resource group to be specified when a new app service plan is to be created.
         */
        interface ExistingWindowsPlanWithGroup {
            
Associates the resource with an existing resource group.
Params:
groupName – the name of an existing resource group to put this resource in.
Returns:
the next stage of the definition/**
             * Associates the resource with an existing resource group.
             * @param groupName the name of an existing resource group to put this resource in.
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withExistingResourceGroup(String groupName);

            
Associates the resource with an existing resource group.
Params:
group – an existing resource group to put the resource in
Returns:
the next stage of the definition/**
             * Associates the resource with an existing resource group.
             * @param group an existing resource group to put the resource in
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withExistingResourceGroup(ResourceGroup group);

            
Creates a new resource group to put the resource in.

The group will be created in the same location as the resource.
Params:
name – the name of the new group
Returns:
the next stage of the definition/**
             * Creates a new resource group to put the resource in.
             * <p>
             * The group will be created in the same location as the resource.
             * @param name the name of the new group
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withNewResourceGroup(String name);

            
Creates a new resource group to put the resource in.

The group will be created in the same location as the resource.
The group's name is automatically derived from the resource's name.
Returns:
the next stage of the definition/**
             * Creates a new resource group to put the resource in.
             * <p>
             * The group will be created in the same location as the resource.
             * The group's name is automatically derived from the resource's name.
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withNewResourceGroup();

            
Creates a new resource group to put the resource in, based on the definition specified.
Params:
groupDefinition – a creatable definition for a new resource group
Returns:
the next stage of the definition/**
             * Creates a new resource group to put the resource in, based on the definition specified.
             * @param groupDefinition a creatable definition for a new resource group
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withNewResourceGroup(Creatable<ResourceGroup> groupDefinition);
        }

        
A web app definition allowing resource group to be specified when a new app service plan is to be created.
/**
         * A web app definition allowing resource group to be specified when a new app service plan is to be created.
         */
        interface ExistingLinuxPlanWithGroup {
            
Associates the resource with an existing resource group.
Params:
groupName – the name of an existing resource group to put this resource in.
Returns:
the next stage of the definition/**
             * Associates the resource with an existing resource group.
             * @param groupName the name of an existing resource group to put this resource in.
             * @return the next stage of the definition
             */
            WithDockerContainerImage withExistingResourceGroup(String groupName);

            
Associates the resource with an existing resource group.
Params:
group – an existing resource group to put the resource in
Returns:
the next stage of the definition/**
             * Associates the resource with an existing resource group.
             * @param group an existing resource group to put the resource in
             * @return the next stage of the definition
             */
            WithDockerContainerImage withExistingResourceGroup(ResourceGroup group);

            
Creates a new resource group to put the resource in.

The group will be created in the same location as the resource.
Params:
name – the name of the new group
Returns:
the next stage of the definition/**
             * Creates a new resource group to put the resource in.
             * <p>
             * The group will be created in the same location as the resource.
             * @param name the name of the new group
             * @return the next stage of the definition
             */
            WithDockerContainerImage withNewResourceGroup(String name);

            
Creates a new resource group to put the resource in.

The group will be created in the same location as the resource.
The group's name is automatically derived from the resource's name.
Returns:
the next stage of the definition/**
             * Creates a new resource group to put the resource in.
             * <p>
             * The group will be created in the same location as the resource.
             * The group's name is automatically derived from the resource's name.
             * @return the next stage of the definition
             */
            WithDockerContainerImage withNewResourceGroup();

            
Creates a new resource group to put the resource in, based on the definition specified.
Params:
groupDefinition – a creatable definition for a new resource group
Returns:
the next stage of the definition/**
             * Creates a new resource group to put the resource in, based on the definition specified.
             * @param groupDefinition a creatable definition for a new resource group
             * @return the next stage of the definition
             */
            WithDockerContainerImage withNewResourceGroup(Creatable<ResourceGroup> groupDefinition);
        }

        
A web app definition allowing app service plan to be set.
/**
         * A web app definition allowing app service plan to be set.
         */
        interface WithNewAppServicePlan {
            
Creates a new free app service plan. This will fail if there are 10 or more
free plans in the current subscription.
Returns:
the next stage of the definition/**
             * Creates a new free app service plan. This will fail if there are 10 or more
             * free plans in the current subscription.
             *
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withNewFreeAppServicePlan();

            
Creates a new shared app service plan.
Returns:
the next stage of the definition/**
             * Creates a new shared app service plan.
             *
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withNewSharedAppServicePlan();

            
Creates a new app service plan to use.
Params:
pricingTier – the sku of the app service plan
Returns:
the next stage of the definition/**
             * Creates a new app service plan to use.
             *
             * @param pricingTier the sku of the app service plan
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withNewWindowsPlan(PricingTier pricingTier);

            
Creates a new app service plan to use.
Params:
appServicePlanName – the name of the new app service plan
pricingTier – the sku of the app service plan
Returns:
the next stage of the definition/**
             * Creates a new app service plan to use.
             *
             * @param appServicePlanName the name of the new app service plan
             * @param pricingTier the sku of the app service plan
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withNewWindowsPlan(String appServicePlanName, PricingTier pricingTier);

            
Creates a new app service plan to use.
Params:
appServicePlanCreatable – the new app service plan creatable
Returns:
the next stage of the definition/**
             * Creates a new app service plan to use.
             *
             * @param appServicePlanCreatable the new app service plan creatable
             * @return the next stage of the definition
             */
            WithWindowsRuntimeStack withNewWindowsPlan(Creatable<AppServicePlan> appServicePlanCreatable);

            
Creates a new app service plan to use.
Params:
pricingTier – the sku of the app service plan
Returns:
the next stage of the definition/**
             * Creates a new app service plan to use.
             *
             * @param pricingTier the sku of the app service plan
             * @return the next stage of the definition
             */
            WithDockerContainerImage withNewLinuxPlan(PricingTier pricingTier);

            
Creates a new app service plan to use.
Params:
appServicePlanName – the name of the new app service plan
pricingTier – the sku of the app service plan
Returns:
the next stage of the definition/**
             * Creates a new app service plan to use.
             *
             * @param appServicePlanName the name of the new app service plan
             * @param pricingTier the sku of the app service plan
             * @return the next stage of the definition
             */
            WithDockerContainerImage withNewLinuxPlan(String appServicePlanName, PricingTier pricingTier);

            
Creates a new app service plan to use.
Params:
appServicePlanCreatable – the new app service plan creatable
Returns:
the next stage of the definition/**
             * Creates a new app service plan to use.
             *
             * @param appServicePlanCreatable the new app service plan creatable
             * @return the next stage of the definition
             */
            WithDockerContainerImage withNewLinuxPlan(Creatable<AppServicePlan> appServicePlanCreatable);
        }

        
A web app definition allowing docker image source to be specified.
/**
         * A web app definition allowing docker image source to be specified.
         */
        interface WithDockerContainerImage {
            
Specifies the docker container image to be a built in one.
Params:
runtimeStack – the runtime stack installed on the image
Returns:
the next stage of the definition/**
             * Specifies the docker container image to be a built in one.
             * @param runtimeStack the runtime stack installed on the image
             * @return the next stage of the definition
             */
            WithCreate withBuiltInImage(RuntimeStack runtimeStack);

            
Specifies the docker container image to be one from Docker Hub.
Params:
imageAndTag – image and optional tag (eg 'image:tag')
Returns:
the next stage of the definition/**
             * Specifies the docker container image to be one from Docker Hub.
             * @param imageAndTag image and optional tag (eg 'image:tag')
             * @return the next stage of the definition
             */
            WithStartUpCommand withPublicDockerHubImage(String imageAndTag);

            
Specifies the docker container image to be one from Docker Hub.
Params:
imageAndTag – image and optional tag (eg 'image:tag')
Returns:
the next stage of the definition/**
             * Specifies the docker container image to be one from Docker Hub.
             * @param imageAndTag image and optional tag (eg 'image:tag')
             * @return the next stage of the definition
             */
            WithCredentials withPrivateDockerHubImage(String imageAndTag);

            
Specifies the docker container image to be one from a private registry.
Params:
imageAndTag – image and optional tag (eg 'image:tag')
serverUrl – the URL to the private registry server
Returns:
the next stage of the definition/**
             * Specifies the docker container image to be one from a private registry.
             * @param imageAndTag image and optional tag (eg 'image:tag')
             * @param serverUrl the URL to the private registry server
             * @return the next stage of the definition
             */
            WithCredentials withPrivateRegistryImage(String imageAndTag, String serverUrl);
        }

        
A web app definition allowing docker registry credentials to be set.
/**
         * A web app definition allowing docker registry credentials to be set.
         */
        interface WithCredentials {
            
Specifies the username and password for Docker Hub or the docker registry.
Params:
username – the username for Docker Hub or the docker registry
password – the password for Docker Hub or the docker registry
Returns:
the next stage of the definition/**
             * Specifies the username and password for Docker Hub or the docker registry.
             * @param username the username for Docker Hub or the docker registry
             * @param password the password for Docker Hub or the docker registry
             * @return the next stage of the definition
             */
            WithStartUpCommand withCredentials(String username, String password);
        }

        
A web app definition allowing docker startup command to be specified.
This will replace the "CMD" section in the Dockerfile.
/**
         * A web app definition allowing docker startup command to be specified.
         * This will replace the "CMD" section in the Dockerfile.
         */
        interface WithStartUpCommand extends WithCreate {
            
Specifies the startup command.
Params:
startUpCommand – startup command to replace "CMD" in Dockerfile
Returns:
the next stage of the definition/**
             * Specifies the startup command.
             * @param startUpCommand startup command to replace "CMD" in Dockerfile
             * @return the next stage of the definition
             */
            WithCreate withStartUpCommand(String startUpCommand);
        }

        
A web app definition allowing runtime stack on Windows operating system to be specified.
/**
         * A web app definition allowing runtime stack on Windows operating system to be specified.
         */
        interface WithWindowsRuntimeStack extends WithCreate {
            
Specifies the runtime stack for the web app on Windows operating system.
Params:
runtimeStack – the runtime stack for web app
Returns:
the next stage of the definition/**
             * Specifies the runtime stack for the web app on Windows operating system.
             * @param runtimeStack the runtime stack for web app
             * @return the next stage of the definition
             */
            WithCreate withRuntimeStack(WebAppRuntimeStack runtimeStack);
        }

        
A site definition with sufficient inputs to create a new web app /
deployments slot in the cloud, but exposing additional optional
inputs to specify.
/**
         * A site definition with sufficient inputs to create a new web app /
         * deployments slot in the cloud, but exposing additional optional
         * inputs to specify.
         */
        interface WithCreate extends
            Creatable<WebApp>,
            WebAppBase.DefinitionStages.WithCreate<WebApp> {
        }
    }

    
Grouping of all the web app update stages.
/**
     * Grouping of all the web app update stages.
     */
    interface UpdateStages {
        
A web app update allowing app service plan to be set.
/**
         * A web app update allowing app service plan to be set.
         */
        interface WithAppServicePlan {
            
Creates a new free app service plan. This will fail if there are 10 or more
free plans in the current subscription.
Returns:
the next stage of the web app update/**
             * Creates a new free app service plan. This will fail if there are 10 or more
             * free plans in the current subscription.
             *
             * @return the next stage of the web app update
             */
            Update withNewFreeAppServicePlan();

            
Creates a new shared app service plan.
Returns:
the next stage of the web app update/**
             * Creates a new shared app service plan.
             *
             * @return the next stage of the web app update
             */
            Update withNewSharedAppServicePlan();

            
Creates a new app service plan to use.
Params:
pricingTier – the sku of the app service plan
Returns:
the next stage of the web app update/**
             * Creates a new app service plan to use.
             *
             * @param pricingTier the sku of the app service plan
             * @return the next stage of the web app update
             */
            Update withNewAppServicePlan(PricingTier pricingTier);

            
Creates a new app service plan to use.
Params:
appServicePlanName – the name of the new app service plan
pricingTier – the sku of the app service plan
Returns:
the next stage of the web app update/**
             * Creates a new app service plan to use.
             *
             * @param appServicePlanName the name of the new app service plan
             * @param pricingTier the sku of the app service plan
             * @return the next stage of the web app update
             */
            Update withNewAppServicePlan(String appServicePlanName, PricingTier pricingTier);

            
Creates a new app service plan to use.
Params:
appServicePlanCreatable – the new app service plan creatable
Returns:
the next stage of the web app update/**
             * Creates a new app service plan to use.
             *
             * @param appServicePlanCreatable the new app service plan creatable
             * @return the next stage of the web app update
             */
            Update withNewAppServicePlan(Creatable<AppServicePlan> appServicePlanCreatable);

            
Uses an existing app service plan for the web app.
Params:
appServicePlan – the existing app service plan
Returns:
the next stage of the web app update/**
             * Uses an existing app service plan for the web app.
             * @param appServicePlan the existing app service plan
             * @return the next stage of the web app update
             */
            Update withExistingAppServicePlan(AppServicePlan appServicePlan);
        }

        
A web app update allowing docker image source to be specified.
/**
         * A web app update allowing docker image source to be specified.
         */
        interface WithDockerContainerImage {
            
Specifies the docker container image to be a built in one.
Params:
runtimeStack – the runtime stack installed on the image
Returns:
the next stage of the web app update/**
             * Specifies the docker container image to be a built in one.
             * @param runtimeStack the runtime stack installed on the image
             * @return the next stage of the web app update
             */
            Update withBuiltInImage(RuntimeStack runtimeStack);

            
Specifies the docker container image to be one from Docker Hub.
Params:
imageAndTag – image and optional tag (eg 'image:tag')
Returns:
the next stage of the web app update/**
             * Specifies the docker container image to be one from Docker Hub.
             * @param imageAndTag image and optional tag (eg 'image:tag')
             * @return the next stage of the web app update
             */
            WithStartUpCommand withPublicDockerHubImage(String imageAndTag);

            
Specifies the docker container image to be one from Docker Hub.
Params:
imageAndTag – image and optional tag (eg 'image:tag')
Returns:
the next stage of the web app update/**
             * Specifies the docker container image to be one from Docker Hub.
             * @param imageAndTag image and optional tag (eg 'image:tag')
             * @return the next stage of the web app update
             */
            WithCredentials withPrivateDockerHubImage(String imageAndTag);

            
Specifies the docker container image to be one from a private registry.
Params:
imageAndTag – image and optional tag (eg 'image:tag')
serverUrl – the URL to the private registry server
Returns:
the next stage of the web app update/**
             * Specifies the docker container image to be one from a private registry.
             * @param imageAndTag image and optional tag (eg 'image:tag')
             * @param serverUrl the URL to the private registry server
             * @return the next stage of the web app update
             */
            WithCredentials withPrivateRegistryImage(String imageAndTag, String serverUrl);
        }

        
A web app update allowing docker hub credentials to be set.
/**
         * A web app update allowing docker hub credentials to be set.
         */
        interface WithCredentials {
            
Specifies the username and password for Docker Hub.
Params:
username – the username for Docker Hub
password – the password for Docker Hub
Returns:
the next stage of the web app update/**
             * Specifies the username and password for Docker Hub.
             * @param username the username for Docker Hub
             * @param password the password for Docker Hub
             * @return the next stage of the web app update
             */
            WithStartUpCommand withCredentials(String username, String password);
        }

        
A web app update allowing docker startup command to be specified.
This will replace the "CMD" section in the Dockerfile.
/**
         * A web app update allowing docker startup command to be specified.
         * This will replace the "CMD" section in the Dockerfile.
         */
        interface WithStartUpCommand extends Update {
            
Specifies the startup command.
Params:
startUpCommand – startup command to replace "CMD" in Dockerfile
Returns:
the next stage of the web app update/**
             * Specifies the startup command.
             * @param startUpCommand startup command to replace "CMD" in Dockerfile
             * @return the next stage of the web app update
             */
            Update withStartUpCommand(String startUpCommand);
        }

        
A web app update allowing runtime stack on Windows operating system to be specified.
/**
         * A web app update allowing runtime stack on Windows operating system to be specified.
         */
        interface WithWindowsRuntimeStack {
            
Specifies the runtime stack for the web app on Windows operating system.
Params:
runtimeStack – the runtime stack for web app
Returns:
the next stage of the web app update/**
             * Specifies the runtime stack for the web app on Windows operating system.
             * @param runtimeStack the runtime stack for web app
             * @return the next stage of the web app update
             */
            Update withRuntimeStack(WebAppRuntimeStack runtimeStack);
        }
    }

    
The template for a web app update operation, containing all the settings that can be modified.
/**
     * The template for a web app update operation, containing all the settings that can be modified.
     */
    interface Update extends
            Appliable<WebApp>,
            UpdateStages.WithAppServicePlan,
            UpdateStages.WithWindowsRuntimeStack,
            WebAppBase.Update<WebApp>,
            UpdateStages.WithDockerContainerImage {
    }
}