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.network;

import java.util.Map;

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.network.implementation.ApplicationGatewayRedirectConfigurationInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ChildResource;
import com.microsoft.azure.management.resources.fluentcore.model.Attachable;
import com.microsoft.azure.management.resources.fluentcore.model.Settable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;

A client-side representation of an application gateway's redirect configuration.
/**
 * A client-side representation of an application gateway's redirect configuration.
 */
@Fluent()
@Beta(SinceVersion.V1_4_0)
public interface ApplicationGatewayRedirectConfiguration extends
    HasInner<ApplicationGatewayRedirectConfigurationInner>,
    ChildResource<ApplicationGateway> {

    
Returns:
the type of redirection./**
     * @return the type of redirection.
     */
    ApplicationGatewayRedirectType type();

    
Returns:
the target listener on this application network traffic is redirected to/**
     * @return the target listener on this application network traffic is redirected to
     */
    ApplicationGatewayListener targetListener();

    
Returns:
the target URL network traffic is redirected to/**
     * @return the target URL network traffic is redirected to
     */
    String targetUrl();

    
Returns:
request routing rules on this application referencing this redirect configuration, indexed by name/**
     * @return request routing rules on this application referencing this redirect configuration, indexed by name
     */
    Map<String, ApplicationGatewayRequestRoutingRule> requestRoutingRules();

    
Returns:
true if the path is included in the redirected URL, otherwise false/**
     * @return true if the path is included in the redirected URL, otherwise false
     */
    boolean isPathIncluded();

    
Returns:
true if the query string is included in the redirected URL, otherwise false/**
     * @return true if the query string is included in the redirected URL, otherwise false
     */
    boolean isQueryStringIncluded();

    
Grouping of application gateway redirect configuration configuration stages.
/**
     * Grouping of application gateway redirect configuration configuration stages.
     */
    interface DefinitionStages {
        
The first stage of an application gateway redirect configuration.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/**
         * The first stage of an application gateway redirect configuration.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface Blank<ReturnT> extends WithType<ReturnT> {
        }

        
The stage of an application gateway redirect configuration allowing to specify the target URL or listener for the redirection.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify the target URL or listener for the redirection.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithTarget<ReturnT> {
            
Specifies the URL to redirect to.
Params:
url – a URL
Returns:
the next stage of the definition/**
             * Specifies the URL to redirect to.
             * @param url a URL
             * @return the next stage of the definition
             */
            WithAttach<ReturnT> withTargetUrl(String url);

            
Specifies the listener on this application gateway to redirect to.
Params:
name – the name of a listener on this application gateway
Returns:
the next stage of the definition/**
             * Specifies the listener on this application gateway to redirect to.
             * @param name the name of a listener on this application gateway
             * @return the next stage of the definition
             */
            WithAttachAndPath<ReturnT> withTargetListener(String name);
        }

        
The stage of an application gateway redirect configuration allowing to specify the type of the redirection.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify the type of the redirection.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithType<ReturnT> {
            
Specifies the redirection type.
Params:
redirectType – a redirection type
Returns:
the next stage of the definition/**
             * Specifies the redirection type.
             * @param redirectType a redirection type
             * @return the next stage of the definition
             */
            WithTarget<ReturnT> withType(ApplicationGatewayRedirectType redirectType);
        }

        
The stage of an application gateway redirect configuration allowing to specify whether the path should be included in the redirected URL.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify whether the path should be included in the redirected URL.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithPathIncluded<ReturnT> {
            
Specifies that the path should be included in the redirected URL.

Note that this setting is valid only when the target of the redirection is a listener, not a URL.
Returns:
the next stage of the definition/**
             * Specifies that the path should be included in the redirected URL.
             * <p>
             * Note that this setting is valid only when the target of the redirection is a listener, not a URL.
             * @return the next stage of the definition
             */
            WithAttach<ReturnT> withPathIncluded();
        }

        
The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithQueryStringIncluded<ReturnT> {
            
Specifies that the query string should be included in the redirected URL.
Returns:
the next stage of the definition/**
             * Specifies that the query string should be included in the redirected URL.
             * @return the next stage of the definition
             */
            WithAttach<ReturnT> withQueryStringIncluded();
        }

        
The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL or other optional settings.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL or other optional settings.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithAttachAndPath<ReturnT> extends WithAttach<ReturnT>, WithPathIncluded<ReturnT> {
        }

        
The final stage of an application gateway redirect configuration.

At this stage, any remaining optional settings can be specified, or the definition
can be attached to the parent application gateway definition.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/**
         * The final stage of an application gateway redirect configuration.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent application gateway definition.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithAttach<ReturnT> extends
            Attachable.InDefinition<ReturnT>,
            WithQueryStringIncluded<ReturnT> {
        }
    }

    
The entirety of an application gateway redirect configuration definition.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/** The entirety of an application gateway redirect configuration definition.
     * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
     */
    interface Definition<ReturnT> extends
        DefinitionStages.Blank<ReturnT>,
        DefinitionStages.WithAttach<ReturnT>,
        DefinitionStages.WithAttachAndPath<ReturnT>,
        DefinitionStages.WithTarget<ReturnT>,
        DefinitionStages.WithType<ReturnT> {
    }

    
Grouping of application gateway redirect configuration update stages.
/**
     * Grouping of application gateway redirect configuration update stages.
     */
    interface UpdateStages {
        
The stage of an application gateway redirect configuration allowing to specify the target URL or listener for the redirection.
/**
         * The stage of an application gateway redirect configuration allowing to specify the target URL or listener for the redirection.
         */
        interface WithTarget {
            
Specifies the URL to redirect to.
Params:
url – a URL
Returns:
the next stage of the update/**
             * Specifies the URL to redirect to.
             * @param url a URL
             * @return the next stage of the update
             */
            Update withTargetUrl(String url);

            
Specifies the listener on this application gateway to redirect to.
Params:
name – the name of a listener on this application gateway
Returns:
the next stage of the update/**
             * Specifies the listener on this application gateway to redirect to.
             * @param name the name of a listener on this application gateway
             * @return the next stage of the update
             */
            Update withTargetListener(String name);

            
Removes the reference to the target listener.
Returns:
the next stage of the update/**
             * Removes the reference to the target listener.
             * @return the next stage of the update
             */
            Update withoutTargetListener();

            
Removes the reference to the target URL.
Returns:
the next stage of the update/**
             * Removes the reference to the target URL.
             * @return the next stage of the update
             */
            Update withoutTargetUrl();
        }

        
The stage of an application gateway redirect configuration allowing to specify the type of the redirection.
/**
         * The stage of an application gateway redirect configuration allowing to specify the type of the redirection.
         */
        interface WithType {
            
Specifies the redirection type.
Params:
redirectType – a redirection type
Returns:
the next stage of the update/**
             * Specifies the redirection type.
             * @param redirectType a redirection type
             * @return the next stage of the update
             */
            Update withType(ApplicationGatewayRedirectType redirectType);
        }

        
The stage of an application gateway redirect configuration allowing to specify whether the path should be included in the redirected URL.
/**
         * The stage of an application gateway redirect configuration allowing to specify whether the path should be included in the redirected URL.
         */
        interface WithPathIncluded {
            
Specifies that the path should be included in the redirected URL.

Note that this setting is valid only when the target of the redirection is a listener, not a URL.
Returns:
the next stage of the update/**
             * Specifies that the path should be included in the redirected URL.
             * <p>
             * Note that this setting is valid only when the target of the redirection is a listener, not a URL.
             * @return the next stage of the update
             */
            Update withPathIncluded();

            
Specifies that the path should not be included in the redirected URL.
Returns:
the next stage of the update/**
             * Specifies that the path should not be included in the redirected URL.
             * @return the next stage of the update
             */
            Update withoutPathIncluded();
        }

        
The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL.
/**
         * The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL.
         */
        interface WithQueryStringIncluded {
            
Specifies that the query string should be included in the redirected URL.
Returns:
the next stage of the update/**
             * Specifies that the query string should be included in the redirected URL.
             * @return the next stage of the update
             */
            Update withQueryStringIncluded();

            
Specifies that the query string should not be included in the redirected URL.
Returns:
the next stage of the update/**
             * Specifies that the query string should not be included in the redirected URL.
             * @return the next stage of the update
             */
            Update withoutQueryStringIncluded();
        }
    }

    
The entirety of an application gateway redirect configuration update as part of an application gateway update.
/**
     * The entirety of an application gateway redirect configuration update as part of an application gateway update.
     */
    interface Update extends
        Settable<ApplicationGateway.Update>,
        UpdateStages.WithTarget,
        UpdateStages.WithType,
        UpdateStages.WithPathIncluded,
        UpdateStages.WithQueryStringIncluded {
    }

    
Grouping of application gateway redirect configuration definition stages applicable as part of an application gateway update.
/**
     * Grouping of application gateway redirect configuration definition stages applicable as part of an application gateway update.
     */
    interface UpdateDefinitionStages {
        
The first stage of an application gateway redirect configuration configuration definition.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/**
         * The first stage of an application gateway redirect configuration configuration definition.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface Blank<ReturnT> extends WithType<ReturnT> {
        }

        
The stage of an application gateway redirect configuration allowing to specify the target URL or listener for the redirection.
Type parameters:
<ReturnT> – the stage of the parent application gateway update to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify the target URL or listener for the redirection.
         * @param <ReturnT> the stage of the parent application gateway update to return to after attaching this definition
         */
        interface WithTarget<ReturnT> {
            
Specifies the URL to redirect to.
Params:
url – a URL
Returns:
the next stage of the definition/**
             * Specifies the URL to redirect to.
             * @param url a URL
             * @return the next stage of the definition
             */
            WithAttach<ReturnT> withTargetUrl(String url);

            
Specifies the listener on this application gateway to redirect to.
Params:
name – the name of a listener on this application gateway
Returns:
the next stage of the definition/**
             * Specifies the listener on this application gateway to redirect to.
             * @param name the name of a listener on this application gateway
             * @return the next stage of the definition
             */
            WithAttachAndPath<ReturnT> withTargetListener(String name);
        }

        
The stage of an application gateway redirect configuration allowing to specify the type of the redirection.
Type parameters:
<ReturnT> – the stage of the parent application gateway update to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify the type of the redirection.
         * @param <ReturnT> the stage of the parent application gateway update to return to after attaching this definition
         */
        interface WithType<ReturnT> {
            
Specifies the redirection type.
Params:
redirectType – a redirection type
Returns:
the next stage of the definition/**
             * Specifies the redirection type.
             * @param redirectType a redirection type
             * @return the next stage of the definition
             */
            WithTarget<ReturnT> withType(ApplicationGatewayRedirectType redirectType);
        }

        
The stage of an application gateway redirect configuration allowing to specify whether the path should be included in the redirected URL.
Type parameters:
<ReturnT> – the stage of the parent application gateway update to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify whether the path should be included in the redirected URL.
         * @param <ReturnT> the stage of the parent application gateway update to return to after attaching this definition
         */
        interface WithPathIncluded<ReturnT> {
            
Specifies that the path should be included in the redirected URL.

Note that this setting is valid only when the target of the redirection is a listener, not a URL.
Returns:
the next stage of the definition/**
             * Specifies that the path should be included in the redirected URL.
             * <p>
             * Note that this setting is valid only when the target of the redirection is a listener, not a URL.
             * @return the next stage of the definition
             */
            WithAttach<ReturnT> withPathIncluded();
        }

        
The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL.
Type parameters:
<ReturnT> – the stage of the parent application gateway update to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL.
         * @param <ReturnT> the stage of the parent application gateway update to return to after attaching this definition
         */
        interface WithQueryStringIncluded<ReturnT> {
            
Specifies that the query string should be included in the redirected URL.
Returns:
the next stage of the definition/**
             * Specifies that the query string should be included in the redirected URL.
             * @return the next stage of the definition
             */
            WithAttach<ReturnT> withQueryStringIncluded();
        }

        
The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL or other optional settings.
Type parameters:
<ReturnT> – the stage of the parent application gateway update to return to after attaching this definition/**
         * The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL or other optional settings.
         * @param <ReturnT> the stage of the parent application gateway update to return to after attaching this definition
         */
        interface WithAttachAndPath<ReturnT> extends WithAttach<ReturnT>, WithPathIncluded<ReturnT> {
        }

        
The final stage of an application gateway redirect configuration definition.

At this stage, any remaining optional settings can be specified, or the definition
can be attached to the parent application gateway definition.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/** The final stage of an application gateway redirect configuration definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent application gateway definition.
         * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithAttach<ReturnT> extends
            Attachable.InUpdate<ReturnT>,
            WithQueryStringIncluded<ReturnT> {
        }
    }

    
The entirety of an application gateway redirect configuration definition as part of an application gateway update.
Type parameters:
<ReturnT> – the stage of the parent application gateway definition to return to after attaching this definition/** The entirety of an application gateway redirect configuration definition as part of an application gateway update.
     * @param <ReturnT> the stage of the parent application gateway definition to return to after attaching this definition
     */
    interface UpdateDefinition<ReturnT> extends
        UpdateDefinitionStages.Blank<ReturnT>,
        UpdateDefinitionStages.WithAttach<ReturnT>,
        UpdateDefinitionStages.WithAttachAndPath<ReturnT>,
        UpdateDefinitionStages.WithTarget<ReturnT>,
        UpdateDefinitionStages.WithType<ReturnT> {
    }
}