CdnEndpoint Interface

Package:

com.azure.resourcemanager.cdn.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cdn:2.46.0

Implements

ExternalChildResource<CdnEndpoint,CdnProfile> HasInnerModel<EndpointInner>

public interface CdnEndpoint
extends ExternalChildResource<CdnEndpoint,CdnProfile>, HasInnerModel<EndpointInner>

An immutable client-side representation of an Azure CDN endpoint.

Method Summary

Modifier and Type	Method and Description
abstract Set<String>	contentTypesToCompress() Gets content types to be compressed.
abstract Set<String>	customDomains() Gets custom domains associated with this endpoint.
abstract Collection<GeoFilter>	geoFilters() Gets list of Geo filters.
abstract String	hostname() Gets endpoint host name.
abstract int	httpPort() Gets HTTP port value.
abstract int	httpsPort() Gets HTTPS port value.
abstract boolean	isCompressionEnabled() Check whether content compression is enabled.
abstract boolean	isHttpAllowed() Check whether HTTP traffic is allowed.
abstract boolean	isHttpsAllowed() Check whether HTTPS traffic is allowed.
abstract PagedIterable<ResourceUsage>	listResourceUsage() Checks the quota and usage of geo filters and custom domains under the current endpoint.
abstract void	loadContent(Set<String> contentPaths) Forcibly preloads the content of the CDN endpoint.
abstract Mono<Void>	loadContentAsync(Set<String> contentPaths) Forcibly preloads the content of the CDN endpoint asynchronously.
abstract String	optimizationType() Gets optimization type.
abstract String	originHostHeader() Gets origin host header.
abstract String	originHostName() Gets origin host nam.
abstract String	originPath() Gets origin path.
abstract String	provisioningState() Gets endpoint provisioning state.
abstract void	purgeContent(Set<String> contentPaths) Forcibly purges the content of the CDN endpoint.
abstract Mono<Void>	purgeContentAsync(Set<String> contentPaths) Forcibly purges the content of the CDN endpoint asynchronously.
abstract QueryStringCachingBehavior	queryStringCachingBehavior() Gets query string caching behavior.
abstract EndpointResourceState	resourceState() Gets endpoint state.
abstract Map<String,DeliveryRule>	standardRulesEngineRules() Gets the map of the Standard rules engine rules.
abstract void	start() Starts the CDN endpoint, if it is stopped.
abstract Mono<Void>	startAsync() Starts the CDN endpoint asynchronously, if it is stopped.
abstract void	stop() Stops the CDN endpoint, if it is running.
abstract Mono<Void>	stopAsync() Stops the CDN endpoint asynchronously, if it is running.
abstract CustomDomainValidationResult	validateCustomDomain(String hostName) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint.
abstract Mono<CustomDomainValidationResult>	validateCustomDomainAsync(String hostName) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint asynchronously.

Method Details

contentTypesToCompress

public abstract Set contentTypesToCompress()

Gets content types to be compressed.

Returns:

content types to be compressed

customDomains

public abstract Set customDomains()

Gets custom domains associated with this endpoint.

Returns:

custom domains associated with this endpoint

geoFilters

public abstract Collection geoFilters()

Gets list of Geo filters.

Returns:

list of Geo filters

hostname

public abstract String hostname()

Gets endpoint host name.

Returns:

endpoint host name

httpPort

public abstract int httpPort()

Gets HTTP port value.

Returns:

HTTP port value

httpsPort

public abstract int httpsPort()

Gets HTTPS port value.

Returns:

HTTPS port value

isCompressionEnabled

public abstract boolean isCompressionEnabled()

Check whether content compression is enabled.

Returns:

true if content compression is enabled, otherwise false

isHttpAllowed

public abstract boolean isHttpAllowed()

Check whether HTTP traffic is allowed.

Returns:

true if HTTP traffic is allowed, otherwise false.

isHttpsAllowed

public abstract boolean isHttpsAllowed()

Check whether HTTPS traffic is allowed.

Returns:

true if HTTPS traffic is allowed, otherwise false

listResourceUsage

public abstract PagedIterable listResourceUsage()

Checks the quota and usage of geo filters and custom domains under the current endpoint.

Returns:

list of quotas and usages of geo filters and custom domains under the current endpoint

loadContent

public abstract void loadContent(Set contentPaths)

Forcibly preloads the content of the CDN endpoint.

Note: this is supported for Verizon profiles only.

Parameters:

contentPaths - the file paths to the content to be loaded

loadContentAsync

public abstract Mono loadContentAsync(Set contentPaths)

Forcibly preloads the content of the CDN endpoint asynchronously.

Note: this is supported for Verizon profiles only.

Parameters:

contentPaths - the file paths to the content to be loaded

Returns:

a representation of the deferred computation of this call

optimizationType

public abstract String optimizationType()

Gets optimization type.

Returns:

optimization type

originHostHeader

public abstract String originHostHeader()

Gets origin host header.

Returns:

origin host header

originHostName

public abstract String originHostName()

Gets origin host nam.

Returns:

origin host name

originPath

public abstract String originPath()

Gets origin path.

Returns:

origin path

provisioningState

public abstract String provisioningState()

Gets endpoint provisioning state.

Returns:

endpoint provisioning state

purgeContent

public abstract void purgeContent(Set contentPaths)

Forcibly purges the content of the CDN endpoint.

Parameters:

contentPaths - the paths to the content to be purged, which can be file paths or directory wild cards.

purgeContentAsync

public abstract Mono purgeContentAsync(Set contentPaths)

Forcibly purges the content of the CDN endpoint asynchronously.

Parameters:

contentPaths - the paths to the content to be purged, which can be file paths or directory wild cards.

Returns:

a representation of the deferred computation of this call

queryStringCachingBehavior

public abstract QueryStringCachingBehavior queryStringCachingBehavior()

Gets query string caching behavior.

Returns:

query string caching behavior

resourceState

public abstract EndpointResourceState resourceState()

Gets endpoint state.

Returns:

endpoint state

standardRulesEngineRules

public abstract Map standardRulesEngineRules()

Gets the map of the Standard rules engine rules.

Returns:

the map of the Standard rules engine rules, indexed by rule name (note: this is only available for Standard Microsoft CDN Sku endpoints)

start

public abstract void start()

Starts the CDN endpoint, if it is stopped.

startAsync

public abstract Mono startAsync()

Starts the CDN endpoint asynchronously, if it is stopped.

Returns:

a representation of the deferred computation of this call

stop

public abstract void stop()

Stops the CDN endpoint, if it is running.

stopAsync

public abstract Mono stopAsync()

Stops the CDN endpoint asynchronously, if it is running.

Returns:

a representation of the deferred computation of this call

validateCustomDomain

public abstract CustomDomainValidationResult validateCustomDomain(String hostName)

Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint.

Parameters:

hostName - the host name, which must be a domain name, of the custom domain

Returns:

the result of the action, if successful.

validateCustomDomainAsync

public abstract Mono validateCustomDomainAsync(String hostName)

Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint asynchronously.

Parameters:

hostName - the host name, which must be a domain name, of the custom domain

Returns:

an observable of the result