CdnEndpoint Interface

Implements

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()
abstract Set<String> customDomains()
abstract Collection<GeoFilter> geoFilters()
abstract String hostname()
abstract int httpPort()
abstract int httpsPort()
abstract boolean isCompressionEnabled()
abstract boolean isHttpAllowed()
abstract boolean isHttpsAllowed()
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()
abstract String originHostHeader()
abstract String originHostName()
abstract String originPath()
abstract String provisioningState()
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()
abstract EndpointResourceState resourceState()
abstract Map<String,DeliveryRule> standardRulesEngineRules()
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()

Returns:

content types to be compressed

customDomains

public abstract Set customDomains()

Returns:

custom domains associated with this endpoint

geoFilters

public abstract Collection geoFilters()

Returns:

list of Geo filters

hostname

public abstract String hostname()

Returns:

endpoint host name

httpPort

public abstract int httpPort()

Returns:

HTTP port value

httpsPort

public abstract int httpsPort()

Returns:

HTTPS port value

isCompressionEnabled

public abstract boolean isCompressionEnabled()

Returns:

true if content compression is enabled, otherwise false

isHttpAllowed

public abstract boolean isHttpAllowed()

Returns:

true if HTTP traffic is allowed, otherwise false.

isHttpsAllowed

public abstract boolean isHttpsAllowed()

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()

Returns:

optimization type

originHostHeader

public abstract String originHostHeader()

Returns:

origin host header

originHostName

public abstract String originHostName()

Returns:

origin host name

originPath

public abstract String originPath()

Returns:

origin path

provisioningState

public abstract String provisioningState()

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()

Returns:

query string caching behavior

resourceState

public abstract EndpointResourceState resourceState()

Returns:

endpoint state

standardRulesEngineRules

public abstract Map standardRulesEngineRules()

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

Applies to