Package com.azure.resourcemanager.cdn.models

Class RouteProperties

java.lang.Object

com.azure.resourcemanager.cdn.models.RouteUpdatePropertiesParameters

com.azure.resourcemanager.cdn.models.RouteProperties

public final class RouteProperties
extends RouteUpdatePropertiesParameters

The JSON object that contains the properties of the Routes to create.

Constructor Summary

Constructors

Constructor	Description
RouteProperties()

Method Summary

Modifier and Type	Method	Description
DeploymentStatus	deploymentStatus()	Get the deploymentStatus property: The deploymentStatus property.
AfdProvisioningState	provisioningState()	Get the provisioningState property: Provisioning status.
void	validate()	Validates the instance.
RouteProperties	withCompressionSettings(Object compressionSettings)	Set the compressionSettings property: compression settings.
RouteProperties	withCustomDomains(List<ResourceReference> customDomains)	Set the customDomains property: Domains referenced by this endpoint.
RouteProperties	withEnabledState(EnabledState enabledState)	Set the enabledState property: Whether to enable use of this rule.
RouteProperties	withForwardingProtocol(ForwardingProtocol forwardingProtocol)	Set the forwardingProtocol property: Protocol this rule will use when forwarding traffic to backends.
RouteProperties	withHttpsRedirect(HttpsRedirect httpsRedirect)	Set the httpsRedirect property: Whether to automatically redirect HTTP traffic to HTTPS traffic.
RouteProperties	withLinkToDefaultDomain(LinkToDefaultDomain linkToDefaultDomain)	Set the linkToDefaultDomain property: whether this route will be linked to the default endpoint domain.
RouteProperties	withOriginGroup(ResourceReference originGroup)	Set the originGroup property: A reference to the origin group.
RouteProperties	withOriginPath(String originPath)	Set the originPath property: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g.
RouteProperties	withPatternsToMatch(List<String> patternsToMatch)	Set the patternsToMatch property: The route patterns of the rule.
RouteProperties	withQueryStringCachingBehavior(AfdQueryStringCachingBehavior queryStringCachingBehavior)	Set the queryStringCachingBehavior property: Defines how CDN caches requests that include query strings.
RouteProperties	withRuleSets(List<ResourceReference> ruleSets)	Set the ruleSets property: rule sets referenced by this endpoint.
RouteProperties	withSupportedProtocols(List<AfdEndpointProtocols> supportedProtocols)	Set the supportedProtocols property: List of supported protocols for this route.

Methods inherited from class com.azure.resourcemanager.cdn.models.RouteUpdatePropertiesParameters

compressionSettings, customDomains, enabledState, forwardingProtocol, httpsRedirect, linkToDefaultDomain, originGroup, originPath, patternsToMatch, queryStringCachingBehavior, ruleSets, supportedProtocols

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RouteProperties

public RouteProperties()

Method Detail

provisioningState

public AfdProvisioningState provisioningState()

Get the provisioningState property: Provisioning status.

Returns:

the provisioningState value.

deploymentStatus

public DeploymentStatus deploymentStatus()

Get the deploymentStatus property: The deploymentStatus property.

Returns:

the deploymentStatus value.

withCustomDomains

public RouteProperties withCustomDomains(List<ResourceReference> customDomains)

Set the customDomains property: Domains referenced by this endpoint.

Overrides:

withCustomDomains in class RouteUpdatePropertiesParameters

Parameters:

customDomains - the customDomains value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withOriginGroup

public RouteProperties withOriginGroup(ResourceReference originGroup)

Set the originGroup property: A reference to the origin group.

Overrides:

withOriginGroup in class RouteUpdatePropertiesParameters

Parameters:

originGroup - the originGroup value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withOriginPath

public RouteProperties withOriginPath(String originPath)

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

Overrides:

withOriginPath in class RouteUpdatePropertiesParameters

Parameters:

originPath - the originPath value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withRuleSets

public RouteProperties withRuleSets(List<ResourceReference> ruleSets)

Set the ruleSets property: rule sets referenced by this endpoint.

Overrides:

withRuleSets in class RouteUpdatePropertiesParameters

Parameters:

ruleSets - the ruleSets value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withSupportedProtocols

public RouteProperties withSupportedProtocols(List<AfdEndpointProtocols> supportedProtocols)

Set the supportedProtocols property: List of supported protocols for this route.

Overrides:

withSupportedProtocols in class RouteUpdatePropertiesParameters

Parameters:

supportedProtocols - the supportedProtocols value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withPatternsToMatch

public RouteProperties withPatternsToMatch(List<String> patternsToMatch)

Set the patternsToMatch property: The route patterns of the rule.

Overrides:

withPatternsToMatch in class RouteUpdatePropertiesParameters

Parameters:

patternsToMatch - the patternsToMatch value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withCompressionSettings

public RouteProperties withCompressionSettings(Object compressionSettings)

Set the compressionSettings property: compression settings.

Overrides:

withCompressionSettings in class RouteUpdatePropertiesParameters

Parameters:

compressionSettings - the compressionSettings value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withQueryStringCachingBehavior

public RouteProperties withQueryStringCachingBehavior(AfdQueryStringCachingBehavior queryStringCachingBehavior)

Set the queryStringCachingBehavior property: 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.

Overrides:

withQueryStringCachingBehavior in class RouteUpdatePropertiesParameters

Parameters:

queryStringCachingBehavior - the queryStringCachingBehavior value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withForwardingProtocol

public RouteProperties withForwardingProtocol(ForwardingProtocol forwardingProtocol)

Set the forwardingProtocol property: Protocol this rule will use when forwarding traffic to backends.

Overrides:

withForwardingProtocol in class RouteUpdatePropertiesParameters

Parameters:

forwardingProtocol - the forwardingProtocol value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withLinkToDefaultDomain

public RouteProperties withLinkToDefaultDomain(LinkToDefaultDomain linkToDefaultDomain)

Set the linkToDefaultDomain property: whether this route will be linked to the default endpoint domain.

Overrides:

withLinkToDefaultDomain in class RouteUpdatePropertiesParameters

Parameters:

linkToDefaultDomain - the linkToDefaultDomain value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withHttpsRedirect

public RouteProperties withHttpsRedirect(HttpsRedirect httpsRedirect)

Set the httpsRedirect property: 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.

Overrides:

withHttpsRedirect in class RouteUpdatePropertiesParameters

Parameters:

httpsRedirect - the httpsRedirect value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

withEnabledState

public RouteProperties withEnabledState(EnabledState enabledState)

Set the enabledState property: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'.

Overrides:

withEnabledState in class RouteUpdatePropertiesParameters

Parameters:

enabledState - the enabledState value to set.

Returns:

the RouteUpdatePropertiesParameters object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class RouteUpdatePropertiesParameters

Throws:

IllegalArgumentException - thrown if the instance is not valid.