RouteInner Class

Package:

com.azure.resourcemanager.cdn.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cdn:2.52.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.cdn.fluent.models.RouteInner

public final class RouteInner
extends ProxyResource

Friendly Routes name mapping to the any Routes or secret related information.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
AfdRouteCacheConfiguration	cacheConfiguration() Get the cacheConfiguration property: The caching configuration for this route.
List<ActivatedResourceReference>	customDomains() Get the customDomains property: Domains referenced by this endpoint.
DeploymentStatus	deploymentStatus() Get the deploymentStatus property: The deploymentStatus property.
EnabledState	enabledState() Get the enabledState property: Whether to enable use of this rule.
String	endpointName() Get the endpointName property: The name of the endpoint which holds the route.
ForwardingProtocol	forwardingProtocol() Get the forwardingProtocol property: Protocol this rule will use when forwarding traffic to backends.
static RouteInner	fromJson(JsonReader jsonReader) Reads an instance of RouteInner from the JsonReader.
HttpsRedirect	httpsRedirect() Get the httpsRedirect property: Whether to automatically redirect HTTP traffic to HTTPS traffic.
String	id() Get the id property: Fully qualified resource Id for the resource.
LinkToDefaultDomain	linkToDefaultDomain() Get the linkToDefaultDomain property: whether this route will be linked to the default endpoint domain.
String	name() Get the name property: The name of the resource.
ResourceReference	originGroup() Get the originGroup property: A reference to the origin group.
String	originPath() Get the originPath property: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g.
List<String>	patternsToMatch() Get the patternsToMatch property: The route patterns of the rule.
AfdProvisioningState	provisioningState() Get the provisioningState property: Provisioning status.
List<ResourceReference>	ruleSets() Get the ruleSets property: rule sets referenced by this endpoint.
List<AfdEndpointProtocols>	supportedProtocols() Get the supportedProtocols property: List of supported protocols for this route.
SystemData	systemData() Get the systemData property: Read only system data.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
RouteInner	withCacheConfiguration(AfdRouteCacheConfiguration cacheConfiguration) Set the cacheConfiguration property: The caching configuration for this route.
RouteInner	withCustomDomains(List<ActivatedResourceReference> customDomains) Set the customDomains property: Domains referenced by this endpoint.
RouteInner	withEnabledState(EnabledState enabledState) Set the enabledState property: Whether to enable use of this rule.
RouteInner	withForwardingProtocol(ForwardingProtocol forwardingProtocol) Set the forwardingProtocol property: Protocol this rule will use when forwarding traffic to backends.
RouteInner	withHttpsRedirect(HttpsRedirect httpsRedirect) Set the httpsRedirect property: Whether to automatically redirect HTTP traffic to HTTPS traffic.
RouteInner	withLinkToDefaultDomain(LinkToDefaultDomain linkToDefaultDomain) Set the linkToDefaultDomain property: whether this route will be linked to the default endpoint domain.
RouteInner	withOriginGroup(ResourceReference originGroup) Set the originGroup property: A reference to the origin group.
RouteInner	withOriginPath(String originPath) Set the originPath property: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g.
RouteInner	withPatternsToMatch(List<String> patternsToMatch) Set the patternsToMatch property: The route patterns of the rule.
RouteInner	withRuleSets(List<ResourceReference> ruleSets) Set the ruleSets property: rule sets referenced by this endpoint.
RouteInner	withSupportedProtocols(List<AfdEndpointProtocols> supportedProtocols) Set the supportedProtocols property: List of supported protocols for this route.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RouteInner

public RouteInner()

Creates an instance of RouteInner class.

Method Details

cacheConfiguration

public AfdRouteCacheConfiguration cacheConfiguration()

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

Returns:

the cacheConfiguration value.

customDomains

public List<ActivatedResourceReference> customDomains()

Get the customDomains property: Domains referenced by this endpoint.

Returns:

the customDomains value.

deploymentStatus

public DeploymentStatus deploymentStatus()

Get the deploymentStatus property: The deploymentStatus property.

Returns:

the deploymentStatus value.

enabledState

public EnabledState enabledState()

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

Returns:

the enabledState value.

endpointName

public String endpointName()

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

Returns:

the endpointName value.

forwardingProtocol

public ForwardingProtocol forwardingProtocol()

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

Returns:

the forwardingProtocol value.

fromJson

public static RouteInner fromJson(JsonReader jsonReader)

Reads an instance of RouteInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

httpsRedirect

public HttpsRedirect httpsRedirect()

Get 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.

Returns:

the httpsRedirect value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

RouteInner.id()

Returns:

the id value.

linkToDefaultDomain

public LinkToDefaultDomain linkToDefaultDomain()

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

Returns:

the linkToDefaultDomain value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

RouteInner.name()

Returns:

the name value.

originGroup

public ResourceReference originGroup()

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

Returns:

the originGroup value.

originPath

public String originPath()

Get the originPath property: 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<String> patternsToMatch()

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

Returns:

the patternsToMatch value.

provisioningState

public AfdProvisioningState provisioningState()

Get the provisioningState property: Provisioning status.

Returns:

the provisioningState value.

ruleSets

public List<ResourceReference> ruleSets()

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

Returns:

the ruleSets value.

supportedProtocols

public List<AfdEndpointProtocols> supportedProtocols()

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

Returns:

the supportedProtocols value.

systemData

public SystemData systemData()

Get the systemData property: Read only system data.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RouteInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

RouteInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withCacheConfiguration

public RouteInner withCacheConfiguration(AfdRouteCacheConfiguration cacheConfiguration)

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

Parameters:

cacheConfiguration - the cacheConfiguration value to set.

Returns:

the RouteInner object itself.

withCustomDomains

public RouteInner withCustomDomains(List<ActivatedResourceReference> customDomains)

Set the customDomains property: Domains referenced by this endpoint.

Parameters:

customDomains - the customDomains value to set.

Returns:

the RouteInner object itself.

withEnabledState

public RouteInner withEnabledState(EnabledState enabledState)

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

Parameters:

enabledState - the enabledState value to set.

Returns:

the RouteInner object itself.

withForwardingProtocol

public RouteInner withForwardingProtocol(ForwardingProtocol forwardingProtocol)

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

Parameters:

forwardingProtocol - the forwardingProtocol value to set.

Returns:

the RouteInner object itself.

withHttpsRedirect

public RouteInner 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.

Parameters:

httpsRedirect - the httpsRedirect value to set.

Returns:

the RouteInner object itself.

withLinkToDefaultDomain

public RouteInner withLinkToDefaultDomain(LinkToDefaultDomain linkToDefaultDomain)

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

Parameters:

linkToDefaultDomain - the linkToDefaultDomain value to set.

Returns:

the RouteInner object itself.

withOriginGroup

public RouteInner withOriginGroup(ResourceReference originGroup)

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

Parameters:

originGroup - the originGroup value to set.

Returns:

the RouteInner object itself.

withOriginPath

public RouteInner 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.

Parameters:

originPath - the originPath value to set.

Returns:

the RouteInner object itself.

withPatternsToMatch

public RouteInner withPatternsToMatch(List<String> patternsToMatch)

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

Parameters:

patternsToMatch - the patternsToMatch value to set.

Returns:

the RouteInner object itself.

withRuleSets

public RouteInner withRuleSets(List<ResourceReference> ruleSets)

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

Parameters:

ruleSets - the ruleSets value to set.

Returns:

the RouteInner object itself.

withSupportedProtocols

public RouteInner withSupportedProtocols(List<AfdEndpointProtocols> supportedProtocols)

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

Parameters:

supportedProtocols - the supportedProtocols value to set.

Returns:

the RouteInner object itself.