CdnEndpoint Interface

Package:

com.microsoft.azure.management.cdn

public interface CdnEndpoint extends ExternalChildResource<CdnEndpoint, CdnProfile>,HasInner

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

Method Summary

Modifier and Type	Method and Description
Set<String>	contentTypesToCompress()
Set<String>	customDomains()
List<GeoFilter>	geoFilters()
String	hostName()
int	httpPort()
int	httpsPort()
boolean	isCompressionEnabled()
boolean	isHttpAllowed()
boolean	isHttpsAllowed()
PagedList<ResourceUsage>	listResourceUsage() Checks the quota and usage of geo filters and custom domains under the current endpoint.
void	loadContent(Set<String> contentPaths) Forcibly preloads the content of the CDN endpoint. Note: this is supported for Verizon profiles only.
Completable	loadContentAsync(Set<String> contentPaths) Forcibly preloads the content of the CDN endpoint asynchronously. Note: this is supported for Verizon profiles only.
ServiceFuture<Void>	loadContentAsync(Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly preloads the content of the CDN endpoint asynchronously. Note: this is supported for Verizon profiles only.
String	optimizationType()
String	originHostHeader()
String	originHostName()
String	originPath()
String	provisioningState()
void	purgeContent(Set<String> contentPaths) Forcibly purges the content of the CDN endpoint.
Completable	purgeContentAsync(Set<String> contentPaths) Forcibly purges the content of the CDN endpoint asynchronously.
ServiceFuture<Void>	purgeContentAsync(Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly purges the content of the CDN endpoint asynchronously.
QueryStringCachingBehavior	queryStringCachingBehavior()
EndpointResourceState	resourceState()
void	start() Starts the CDN endpoint, if it is stopped.
Completable	startAsync() Starts the CDN endpoint asynchronously, if it is stopped.
ServiceFuture<Void>	startAsync(ServiceCallback<Void> callback) Starts the CDN endpoint asynchronously, if it is stopped.
void	stop() Stops the CDN endpoint, if it is running.
Completable	stopAsync() Stops the CDN endpoint asynchronously, if it is running.
ServiceFuture<Void>	stopAsync(ServiceCallback<Void> callback) Stops the CDN endpoint asynchronously, if it is running.
CustomDomainValidationResult	validateCustomDomain(String hostName) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint.
Observable<CustomDomainValidationResult>	validateCustomDomainAsync(String hostName) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint asynchronously.
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.

Inherited Members

ExternalChildResource<FluentModelT,ParentT>.id() HasInner<T>.inner() Indexable.key() HasName.name() HasParent<ParentT>.parent() Refreshable<T>.refresh() Refreshable<T>.refreshAsync()

Method Details

contentTypesToCompress

public Set contentTypesToCompress()

Returns:

content types to be compressed

customDomains

public Set customDomains()

Returns:

custom domains associated with this endpoint

geoFilters

public List geoFilters()

Returns:

list of Geo filters

hostName

public String hostName()

Returns:

endpoint host name

httpPort

public int httpPort()

Returns:

HTTP port value

httpsPort

public int httpsPort()

Returns:

HTTPS port value

isCompressionEnabled

public boolean isCompressionEnabled()

Returns:

true if content compression is enabled, otherwise false

isHttpAllowed

public boolean isHttpAllowed()

Returns:

true if HTTP traffic is allowed, otherwise false.

isHttpsAllowed

public boolean isHttpsAllowed()

Returns:

true if HTTPS traffic is allowed, otherwise false

listResourceUsage

public 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 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 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 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 String optimizationType()

Returns:

optimization type

originHostHeader

public String originHostHeader()

Returns:

origin host header

originHostName

public String originHostName()

Returns:

origin host name

originPath

public String originPath()

Returns:

origin path

provisioningState

public String provisioningState()

Returns:

endpoint provisioning state

purgeContent

public 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 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 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 QueryStringCachingBehavior queryStringCachingBehavior()

Returns:

query string caching behavior

resourceState

public EndpointResourceState resourceState()

Returns:

endpoint state

start

public void start()

Starts the CDN endpoint, if it is stopped.

startAsync

public Completable startAsync()

Starts the CDN endpoint asynchronously, if it is stopped.

Returns:

a representation of the deferred computation of this call

startAsync

public 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 void stop()

Stops the CDN endpoint, if it is running.

stopAsync

public Completable stopAsync()

Stops the CDN endpoint asynchronously, if it is running.

Returns:

a representation of the deferred computation of this call

stopAsync

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