com.microsoft.azure.management.cdn

Interface CdnEndpoint

All Superinterfaces:

ChildResource<CdnProfile>, ExternalChildResource<CdnEndpoint,CdnProfile>, HasInner<com.microsoft.azure.management.cdn.implementation.EndpointInner>, HasName, HasParent<CdnProfile>, Indexable, Refreshable<CdnEndpoint>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CdnEndpoint.DefinitionStages Grouping of CDN profile endpoint definition stages as a part of parent CDN profile definition.
static interface	CdnEndpoint.Update The entirety of a CDN endpoint update as part of a CDN profile update.
static interface	CdnEndpoint.UpdateDefinitionStages The entirety of a CDN profile endpoint definition as a part of a parent CDN profile update.
static interface	CdnEndpoint.UpdatePremiumEndpoint The stage of an CDN profile endpoint update allowing to specify endpoint properties.
static interface	CdnEndpoint.UpdateStandardEndpoint The stage of an CDN profile endpoint update allowing to specify endpoint properties.

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.
rx.Completable	loadContentAsync(Set<String> contentPaths) Forcibly preloads the content of the CDN endpoint asynchronously.
ServiceFuture<Void>	loadContentAsync(Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly preloads the content of the CDN endpoint asynchronously.
String	optimizationType()
String	originHostHeader()
String	originHostName()
String	originPath()
String	provisioningState()
void	purgeContent(Set<String> contentPaths) Forcibly purges the content of the CDN endpoint.
rx.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.
rx.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.
rx.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.
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.
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.

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.ExternalChildResource

id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent

parent

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

inner

Method Detail

originHostHeader

String originHostHeader()

Returns:

origin host header

originPath

String originPath()

Returns:

origin path

contentTypesToCompress

Set<String> contentTypesToCompress()

Returns:

content types to be compressed

isCompressionEnabled

boolean isCompressionEnabled()

Returns:

true if content compression is enabled, otherwise false

isHttpAllowed

boolean isHttpAllowed()

Returns:

true if HTTP traffic is allowed, otherwise false.

isHttpsAllowed

boolean isHttpsAllowed()

Returns:

true if HTTPS traffic is allowed, otherwise false

queryStringCachingBehavior

QueryStringCachingBehavior queryStringCachingBehavior()

Returns:

query string caching behavior

optimizationType

String optimizationType()

Returns:

optimization type

geoFilters

List<GeoFilter> geoFilters()

Returns:

list of Geo filters

hostName

String hostName()

Returns:

endpoint host name

resourceState

EndpointResourceState resourceState()

Returns:

endpoint state

provisioningState

String provisioningState()

Returns:

endpoint provisioning state

originHostName

String originHostName()

Returns:

origin host name

httpPort

int httpPort()

Returns:

HTTP port value

httpsPort

int httpsPort()

Returns:

HTTPS port value

customDomains

Set<String> customDomains()

Returns:

custom domains associated with this endpoint

start

void start()

Starts the CDN endpoint, if it is stopped.

startAsync

rx.Completable startAsync()

Starts the CDN endpoint asynchronously, if it is stopped.

Returns:

a representation of the deferred computation of this call

startAsync

ServiceFuture<Void> startAsync(ServiceCallback<Void> 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

void stop()

Stops the CDN endpoint, if it is running.

stopAsync

rx.Completable stopAsync()

Stops the CDN endpoint asynchronously, if it is running.

Returns:

a representation of the deferred computation of this call

stopAsync

ServiceFuture<Void> stopAsync(ServiceCallback<Void> 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

purgeContent

void purgeContent(Set<String> 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

rx.Completable purgeContentAsync(Set<String> 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

ServiceFuture<Void> purgeContentAsync(Set<String> contentPaths,
                                      ServiceCallback<Void> 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

loadContent

void loadContent(Set<String> 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

rx.Completable loadContentAsync(Set<String> 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

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.

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

validateCustomDomain

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

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.

Parameters:

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

Returns:

an observable of the result

validateCustomDomainAsync

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.

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

listResourceUsage

PagedList<ResourceUsage> 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