com.microsoft.azure.management.network.ApplicationGatewayRedirectConfiguration Maven / Gradle / Ivy
Show all versions of azure-mgmt-network Show documentation
/**
* 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.
*/
@Fluent()
@Beta(SinceVersion.V1_4_0)
public interface ApplicationGatewayRedirectConfiguration extends
HasInner,
ChildResource {
/**
* @return the type of redirection.
*/
ApplicationGatewayRedirectType type();
/**
* @return the target listener on this application network traffic is redirected to
*/
ApplicationGatewayListener targetListener();
/**
* @return the target URL network traffic is redirected to
*/
String targetUrl();
/**
* @return request routing rules on this application referencing this redirect configuration, indexed by name
*/
Map requestRoutingRules();
/**
* @return true if the path is included in the redirected URL, otherwise false
*/
boolean isPathIncluded();
/**
* @return true if the query string is included in the redirected URL, otherwise false
*/
boolean isQueryStringIncluded();
/**
* Grouping of application gateway redirect configuration configuration stages.
*/
interface DefinitionStages {
/**
* The first stage of an application gateway redirect configuration.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface Blank extends WithType {
}
/**
* The stage of an application gateway redirect configuration allowing to specify the target URL or listener for the redirection.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithTarget {
/**
* Specifies the URL to redirect to.
* @param url a URL
* @return the next stage of the definition
*/
WithAttach withTargetUrl(String url);
/**
* 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 withTargetListener(String name);
}
/**
* The stage of an application gateway redirect configuration allowing to specify the type of the redirection.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithType {
/**
* Specifies the redirection type.
* @param redirectType a redirection type
* @return the next stage of the definition
*/
WithTarget withType(ApplicationGatewayRedirectType redirectType);
}
/**
* The stage of an application gateway redirect configuration allowing to specify whether the path should be included in the redirected URL.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
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.
* @return the next stage of the definition
*/
WithAttach withPathIncluded();
}
/**
* The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithQueryStringIncluded {
/**
* Specifies that the query string should be included in the redirected URL.
* @return the next stage of the definition
*/
WithAttach 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.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithAttachAndPath extends WithAttach, WithPathIncluded {
}
/**
* 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.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithAttach extends
Attachable.InDefinition,
WithQueryStringIncluded {
}
}
/** The entirety of an application gateway redirect configuration definition.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface Definition extends
DefinitionStages.Blank,
DefinitionStages.WithAttach,
DefinitionStages.WithAttachAndPath,
DefinitionStages.WithTarget,
DefinitionStages.WithType {
}
/**
* 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.
*/
interface WithTarget {
/**
* 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.
* @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.
* @return the next stage of the update
*/
Update withoutTargetListener();
/**
* 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.
*/
interface WithType {
/**
* 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.
*/
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.
* @return the next stage of the update
*/
Update withPathIncluded();
/**
* 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.
*/
interface WithQueryStringIncluded {
/**
* 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.
* @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.
*/
interface Update extends
Settable,
UpdateStages.WithTarget,
UpdateStages.WithType,
UpdateStages.WithPathIncluded,
UpdateStages.WithQueryStringIncluded {
}
/**
* 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.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface Blank extends WithType {
}
/**
* The stage of an application gateway redirect configuration allowing to specify the target URL or listener for the redirection.
* @param the stage of the parent application gateway update to return to after attaching this definition
*/
interface WithTarget {
/**
* Specifies the URL to redirect to.
* @param url a URL
* @return the next stage of the definition
*/
WithAttach withTargetUrl(String url);
/**
* 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 withTargetListener(String name);
}
/**
* The stage of an application gateway redirect configuration allowing to specify the type of the redirection.
* @param the stage of the parent application gateway update to return to after attaching this definition
*/
interface WithType {
/**
* Specifies the redirection type.
* @param redirectType a redirection type
* @return the next stage of the definition
*/
WithTarget withType(ApplicationGatewayRedirectType redirectType);
}
/**
* The stage of an application gateway redirect configuration allowing to specify whether the path should be included in the redirected URL.
* @param the stage of the parent application gateway update to return to after attaching this definition
*/
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.
* @return the next stage of the definition
*/
WithAttach withPathIncluded();
}
/**
* The stage of an application gateway redirect configuration allowing to specify whether the query string should be included in the redirected URL.
* @param the stage of the parent application gateway update to return to after attaching this definition
*/
interface WithQueryStringIncluded {
/**
* Specifies that the query string should be included in the redirected URL.
* @return the next stage of the definition
*/
WithAttach 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.
* @param the stage of the parent application gateway update to return to after attaching this definition
*/
interface WithAttachAndPath extends WithAttach, WithPathIncluded {
}
/** 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.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface WithAttach extends
Attachable.InUpdate,
WithQueryStringIncluded {
}
}
/** The entirety of an application gateway redirect configuration definition as part of an application gateway update.
* @param the stage of the parent application gateway definition to return to after attaching this definition
*/
interface UpdateDefinition extends
UpdateDefinitionStages.Blank,
UpdateDefinitionStages.WithAttach,
UpdateDefinitionStages.WithAttachAndPath,
UpdateDefinitionStages.WithTarget,
UpdateDefinitionStages.WithType {
}
}