RouteProperties Class

Package:

com.azure.resourcemanager.cdn.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cdn:2.53.7

• java.lang.Object
• • com.azure.resourcemanager.cdn.fluent.models.RouteUpdatePropertiesParameters
  • • com.azure.resourcemanager.cdn.fluent.models.RouteProperties

public final class RouteProperties
extends RouteUpdatePropertiesParameters

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

Constructor Summary

Constructor	Description
RouteProperties()	Creates an instance of RouteProperties class.

Method Summary

Modifier and Type	Method and Description
DeploymentStatus	deploymentStatus() Get the deploymentStatus property: The deploymentStatus property.
String	endpointName() Get the endpointName property: The name of the endpoint which holds the route.
static RouteProperties	fromJson(JsonReader jsonReader) Reads an instance of RouteProperties from the JsonReader.
AfdProvisioningState	provisioningState() Get the provisioningState property: Provisioning status.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
RouteProperties	withCacheConfiguration(AfdRouteCacheConfiguration cacheConfiguration) Set the cacheConfiguration property: The caching configuration for this route.
RouteProperties	withCustomDomains(List<ActivatedResourceReference> 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	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 RouteUpdatePropertiesParameters

cacheConfiguration customDomains enabledState endpointName forwardingProtocol fromJson httpsRedirect linkToDefaultDomain originGroup originPath patternsToMatch ruleSets supportedProtocols toJson validate withCacheConfiguration withCustomDomains withEnabledState withForwardingProtocol withHttpsRedirect withLinkToDefaultDomain withOriginGroup withOriginPath withPatternsToMatch withRuleSets withSupportedProtocols

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RouteProperties

public RouteProperties()

Creates an instance of RouteProperties class.

Method Details

deploymentStatus

public DeploymentStatus deploymentStatus()

Get the deploymentStatus property: The deploymentStatus property.

Returns:

the deploymentStatus value.

endpointName

public String endpointName()

Get the endpointName property: The name of the endpoint which holds the route.

Overrides:

RouteProperties.endpointName()

Returns:

the endpointName value.

fromJson

public static RouteProperties fromJson(JsonReader jsonReader)

Reads an instance of RouteProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RouteProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the RouteProperties.

provisioningState

public AfdProvisioningState provisioningState()

Get the provisioningState property: Provisioning status.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RouteProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

Overrides:

RouteProperties.validate()

withCacheConfiguration

public RouteProperties withCacheConfiguration(AfdRouteCacheConfiguration cacheConfiguration)

Set the cacheConfiguration property: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.

Overrides:

RouteProperties.withCacheConfiguration(AfdRouteCacheConfiguration cacheConfiguration)

Parameters:

cacheConfiguration

withCustomDomains

public RouteProperties withCustomDomains(List<ActivatedResourceReference> customDomains)

Set the customDomains property: Domains referenced by this endpoint.

Overrides:

RouteProperties.withCustomDomains(List<ActivatedResourceReference> customDomains)

Parameters:

customDomains

withEnabledState

public RouteProperties withEnabledState(EnabledState enabledState)

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

Overrides:

RouteProperties.withEnabledState(EnabledState enabledState)

Parameters:

enabledState

withForwardingProtocol

public RouteProperties withForwardingProtocol(ForwardingProtocol forwardingProtocol)

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

Overrides:

RouteProperties.withForwardingProtocol(ForwardingProtocol forwardingProtocol)

Parameters:

forwardingProtocol

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:

RouteProperties.withHttpsRedirect(HttpsRedirect httpsRedirect)

Parameters:

httpsRedirect

withLinkToDefaultDomain

public RouteProperties withLinkToDefaultDomain(LinkToDefaultDomain linkToDefaultDomain)

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

Overrides:

RouteProperties.withLinkToDefaultDomain(LinkToDefaultDomain linkToDefaultDomain)

Parameters:

linkToDefaultDomain

withOriginGroup

public RouteProperties withOriginGroup(ResourceReference originGroup)

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

Overrides:

RouteProperties.withOriginGroup(ResourceReference originGroup)

Parameters:

originGroup

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:

RouteProperties.withOriginPath(String originPath)

Parameters:

originPath

withPatternsToMatch

public RouteProperties withPatternsToMatch(List<String> patternsToMatch)

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

Overrides:

RouteProperties.withPatternsToMatch(List<String> patternsToMatch)

Parameters:

patternsToMatch

withRuleSets

public RouteProperties withRuleSets(List<ResourceReference> ruleSets)

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

Overrides:

RouteProperties.withRuleSets(List<ResourceReference> ruleSets)

Parameters:

ruleSets

withSupportedProtocols

public RouteProperties withSupportedProtocols(List<AfdEndpointProtocols> supportedProtocols)

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

Overrides:

RouteProperties.withSupportedProtocols(List<AfdEndpointProtocols> supportedProtocols)

Parameters:

supportedProtocols