CdnEndpoint Interface

Package:

com.microsoft.azure.management.cdn

Maven Artifact:

com.microsoft.azure:azure-mgmt-cdn:1.41.4

Implements

ExternalChildResource<CdnEndpoint,CdnProfile> HasInner<com.microsoft.azure.management.cdn.implementation.EndpointInner>

public interface CdnEndpoint
extends ExternalChildResource<CdnEndpoint,CdnProfile>, HasInner<com.microsoft.azure.management.cdn.implementation.EndpointInner>

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

Method Summary

Modifier and Type	Method and Description
abstract java.util.Set<java.lang.String>	contentTypesToCompress()
abstract java.util.Set<java.lang.String>	customDomains()
abstract java.util.List<GeoFilter>	geoFilters()
abstract java.lang.String	hostName()
abstract int	httpPort()
abstract int	httpsPort()
abstract boolean	isCompressionEnabled()
abstract boolean	isHttpAllowed()
abstract boolean	isHttpsAllowed()
abstract com.microsoft.azure.PagedList<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 rx.Completable	loadContentAsync(Set<String> contentPaths) Forcibly preloads the content of the CDN endpoint asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	loadContentAsync(Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly preloads the content of the CDN endpoint asynchronously.
abstract java.lang.String	optimizationType()
abstract java.lang.String	originHostHeader()
abstract java.lang.String	originHostName()
abstract java.lang.String	originPath()
abstract java.lang.String	provisioningState()
abstract void	purgeContent(Set<String> contentPaths) Forcibly purges the content of the CDN endpoint.
abstract rx.Completable	purgeContentAsync(Set<String> contentPaths) Forcibly purges the content of the CDN endpoint asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	purgeContentAsync(Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly purges the content of the CDN endpoint asynchronously.
abstract QueryStringCachingBehavior	queryStringCachingBehavior()
abstract EndpointResourceState	resourceState()
abstract void	start() Starts the CDN endpoint, if it is stopped.
abstract rx.Completable	startAsync() Starts the CDN endpoint asynchronously, if it is stopped.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	startAsync(ServiceCallback<Void> callback) Starts the CDN endpoint asynchronously, if it is stopped.
abstract void	stop() Stops the CDN endpoint, if it is running.
abstract rx.Completable	stopAsync() Stops the CDN endpoint asynchronously, if it is running.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	stopAsync(ServiceCallback<Void> callback) 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 rx.Observable<CustomDomainValidationResult>	validateCustomDomainAsync(String hostName) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint asynchronously.
abstract com.microsoft.rest.ServiceFuture<CustomDomainValidationResult>	validateCustomDomainAsync(String hostName, ServiceCallback<CustomDomainValidationResult> callback) 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 List 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 PagedList 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 Completable 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

loadContentAsync

public abstract ServiceFuture loadContentAsync(Set contentPaths, ServiceCallback callback)

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

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

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 Completable 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

purgeContentAsync

public abstract ServiceFuture purgeContentAsync(Set contentPaths, ServiceCallback callback)

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.

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

queryStringCachingBehavior

public abstract QueryStringCachingBehavior queryStringCachingBehavior()

Returns:

query string caching behavior

resourceState

public abstract EndpointResourceState resourceState()

Returns:

endpoint state

start

public abstract void start()

Starts the CDN endpoint, if it is stopped.

startAsync

public abstract Completable startAsync()

Starts the CDN endpoint asynchronously, if it is stopped.

Returns:

a representation of the deferred computation of this call

startAsync

public abstract ServiceFuture startAsync(ServiceCallback callback)

Starts the CDN endpoint asynchronously, if it is stopped.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

stop

public abstract void stop()

Stops the CDN endpoint, if it is running.

stopAsync

public abstract Completable stopAsync()

Stops the CDN endpoint asynchronously, if it is running.

Returns:

a representation of the deferred computation of this call

stopAsync

public abstract ServiceFuture stopAsync(ServiceCallback callback)

Stops the CDN endpoint asynchronously, if it is running.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

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 Observable 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

validateCustomDomainAsync

public abstract ServiceFuture validateCustomDomainAsync(String hostName, ServiceCallback callback)

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

callback - the callback to call on success or failure

Returns:

a handle to cancel the request