RouteUpdateParameters Class

Package:

com.microsoft.azure.management.cdn

Maven Artifact:

com.microsoft.azure:azure-mgmt-cdn:1.41.4

• java.lang.Object
• • com.microsoft.azure.management.cdn.RouteUpdateParameters

public class RouteUpdateParameters

The domain JSON object required for domain creation or update.

Constructor Summary

Constructor	Description
RouteUpdateParameters()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	compressionSettings() Get compression settings.
java.util.List<ResourceReference>	customDomains() Get domains referenced by this endpoint.
EnabledState	enabledState() Get whether to enable use of this rule.
ForwardingProtocol	forwardingProtocol() Get protocol this rule will use when forwarding traffic to backends.
HttpsRedirect	httpsRedirect() Get whether to automatically redirect HTTP traffic to HTTPS traffic.
LinkToDefaultDomain	linkToDefaultDomain() Get whether this route will be linked to the default endpoint domain.
ResourceReference	originGroup() Get a reference to the origin group.
java.lang.String	originPath() Get a directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g.
java.util.List<java.lang.String>	patternsToMatch() Get the route patterns of the rule.
AfdQueryStringCachingBehavior	queryStringCachingBehavior() Get defines how CDN caches requests that include query strings.
java.util.List<ResourceReference>	ruleSets() Get rule sets referenced by this endpoint.
java.util.List<AFDEndpointProtocols>	supportedProtocols() Get list of supported protocols for this route.
RouteUpdateParameters	withCompressionSettings(Object compressionSettings) Set compression settings.
RouteUpdateParameters	withCustomDomains(List<ResourceReference> customDomains) Set domains referenced by this endpoint.
RouteUpdateParameters	withEnabledState(EnabledState enabledState) Set whether to enable use of this rule.
RouteUpdateParameters	withForwardingProtocol(ForwardingProtocol forwardingProtocol) Set protocol this rule will use when forwarding traffic to backends.
RouteUpdateParameters	withHttpsRedirect(HttpsRedirect httpsRedirect) Set whether to automatically redirect HTTP traffic to HTTPS traffic.
RouteUpdateParameters	withLinkToDefaultDomain(LinkToDefaultDomain linkToDefaultDomain) Set whether this route will be linked to the default endpoint domain.
RouteUpdateParameters	withOriginGroup(ResourceReference originGroup) Set a reference to the origin group.
RouteUpdateParameters	withOriginPath(String originPath) Set a directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g.
RouteUpdateParameters	withPatternsToMatch(List<String> patternsToMatch) Set the route patterns of the rule.
RouteUpdateParameters	withQueryStringCachingBehavior(AfdQueryStringCachingBehavior queryStringCachingBehavior) Set defines how CDN caches requests that include query strings.
RouteUpdateParameters	withRuleSets(List<ResourceReference> ruleSets) Set rule sets referenced by this endpoint.
RouteUpdateParameters	withSupportedProtocols(List<AFDEndpointProtocols> supportedProtocols) Set list of supported protocols for this route.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

RouteUpdateParameters

public RouteUpdateParameters()

Method Details

compressionSettings

public Object compressionSettings()

Get compression settings.

Returns:

the compressionSettings value

customDomains

public List customDomains()

Get domains referenced by this endpoint.

Returns:

the customDomains value

enabledState

public EnabledState enabledState()

Get whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'Enabled', 'Disabled'.

Returns:

the enabledState value

forwardingProtocol

public ForwardingProtocol forwardingProtocol()

Get protocol this rule will use when forwarding traffic to backends. Possible values include: 'HttpOnly', 'HttpsOnly', 'MatchRequest'.

Returns:

the forwardingProtocol value

httpsRedirect

public HttpsRedirect httpsRedirect()

Get whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Possible values include: 'Enabled', 'Disabled'.

Returns:

the httpsRedirect value

linkToDefaultDomain

public LinkToDefaultDomain linkToDefaultDomain()

Get whether this route will be linked to the default endpoint domain. Possible values include: 'Enabled', 'Disabled'.

Returns:

the linkToDefaultDomain value

originGroup

public ResourceReference originGroup()

Get a reference to the origin group.

Returns:

the originGroup value

originPath

public String originPath()

Get a directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

Returns:

the originPath value

patternsToMatch

public List patternsToMatch()

Get the route patterns of the rule.

Returns:

the patternsToMatch value

queryStringCachingBehavior

public AfdQueryStringCachingBehavior queryStringCachingBehavior()

Get defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Possible values include: 'IgnoreQueryString', 'UseQueryString', 'NotSet'.

Returns:

the queryStringCachingBehavior value

ruleSets

public List ruleSets()

Get rule sets referenced by this endpoint.

Returns:

the ruleSets value

supportedProtocols

public List supportedProtocols()

Get list of supported protocols for this route.

Returns:

the supportedProtocols value

withCompressionSettings

public RouteUpdateParameters withCompressionSettings(Object compressionSettings)

Set compression settings.

Parameters:

compressionSettings - the compressionSettings value to set

Returns:

the RouteUpdateParameters object itself.

withCustomDomains

public RouteUpdateParameters withCustomDomains(List customDomains)

Set domains referenced by this endpoint.

Parameters:

customDomains - the customDomains value to set

Returns:

the RouteUpdateParameters object itself.

withEnabledState

public RouteUpdateParameters withEnabledState(EnabledState enabledState)

Set whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'Enabled', 'Disabled'.

Parameters:

enabledState - the enabledState value to set

Returns:

the RouteUpdateParameters object itself.

withForwardingProtocol

public RouteUpdateParameters withForwardingProtocol(ForwardingProtocol forwardingProtocol)

Set protocol this rule will use when forwarding traffic to backends. Possible values include: 'HttpOnly', 'HttpsOnly', 'MatchRequest'.

Parameters:

forwardingProtocol - the forwardingProtocol value to set

Returns:

the RouteUpdateParameters object itself.

withHttpsRedirect

public RouteUpdateParameters withHttpsRedirect(HttpsRedirect httpsRedirect)

Set whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. Possible values include: 'Enabled', 'Disabled'.

Parameters:

httpsRedirect - the httpsRedirect value to set

Returns:

the RouteUpdateParameters object itself.

withLinkToDefaultDomain

public RouteUpdateParameters withLinkToDefaultDomain(LinkToDefaultDomain linkToDefaultDomain)

Set whether this route will be linked to the default endpoint domain. Possible values include: 'Enabled', 'Disabled'.

Parameters:

linkToDefaultDomain - the linkToDefaultDomain value to set

Returns:

the RouteUpdateParameters object itself.

withOriginGroup

public RouteUpdateParameters withOriginGroup(ResourceReference originGroup)

Set a reference to the origin group.

Parameters:

originGroup - the originGroup value to set

Returns:

the RouteUpdateParameters object itself.

withOriginPath

public RouteUpdateParameters withOriginPath(String originPath)

Set a directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

Parameters:

originPath - the originPath value to set

Returns:

the RouteUpdateParameters object itself.

withPatternsToMatch

public RouteUpdateParameters withPatternsToMatch(List patternsToMatch)

Set the route patterns of the rule.

Parameters:

patternsToMatch - the patternsToMatch value to set

Returns:

the RouteUpdateParameters object itself.

withQueryStringCachingBehavior

public RouteUpdateParameters withQueryStringCachingBehavior(AfdQueryStringCachingBehavior queryStringCachingBehavior)

Set defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Possible values include: 'IgnoreQueryString', 'UseQueryString', 'NotSet'.

Parameters:

queryStringCachingBehavior - the queryStringCachingBehavior value to set

Returns:

the RouteUpdateParameters object itself.

withRuleSets

public RouteUpdateParameters withRuleSets(List ruleSets)

Set rule sets referenced by this endpoint.

Parameters:

ruleSets - the ruleSets value to set

Returns:

the RouteUpdateParameters object itself.

withSupportedProtocols

public RouteUpdateParameters withSupportedProtocols(List supportedProtocols)

Set list of supported protocols for this route.

Parameters:

supportedProtocols - the supportedProtocols value to set

Returns:

the RouteUpdateParameters object itself.