AfdEndpoint Interface

Implements

public interface AfdEndpoint
extends ExternalChildResource<AfdEndpoint,CdnProfile>, HasInnerModel<AfdEndpointInner>

An immutable client-side representation of an Azure Front Door (AFD) endpoint that lives under a CdnProfile.

Method Summary

Modifier and Type Method and Description
abstract AutoGeneratedDomainNameLabelScope autoGeneratedDomainNameLabelScope()

Gets the scope that determines whether a generated host name can be reused.

abstract DeploymentStatus deploymentStatus()

Gets the deployment status for the endpoint.

abstract EnabledState enabledState()

Gets the enablement state of the endpoint.

abstract String hostname()

Gets the host name assigned to the endpoint.

abstract PagedIterable<Usage> listResourceUsage()

Lists usage information for the endpoint.

abstract AfdProvisioningState provisioningState()

Gets the provisioning state reported by the service.

abstract void purgeContent(List<String> contentPaths)

Purges cached content for the endpoint.

abstract void purgeContent(List<String> contentPaths, List<String> domains)

Purges cached content for the endpoint.

abstract reactor.core.publisher.Mono<Void> purgeContentAsync(List<String> contentPaths)

Purges cached content for the endpoint asynchronously.

abstract reactor.core.publisher.Mono<Void> purgeContentAsync(List<String> contentPaths, List<String> domains)

Purges cached content for the endpoint asynchronously.

abstract Map<String,Route> routes()

Gets latest routes by sending http request.

abstract CustomDomainValidationResult validateCustomDomain(String hostName)

Validates that the provided custom domain maps correctly to this endpoint.

abstract reactor.core.publisher.Mono<CustomDomainValidationResult> validateCustomDomainAsync(String hostName)

Validates that the provided custom domain maps correctly to this endpoint asynchronously.

Method Details

autoGeneratedDomainNameLabelScope

public abstract AutoGeneratedDomainNameLabelScope autoGeneratedDomainNameLabelScope()

Gets the scope that determines whether a generated host name can be reused.

Returns:

the scope that determines whether a generated host name can be reused

deploymentStatus

public abstract DeploymentStatus deploymentStatus()

Gets the deployment status for the endpoint.

Returns:

the deployment status for the endpoint

enabledState

public abstract EnabledState enabledState()

Gets the enablement state of the endpoint.

Returns:

the enablement state of the endpoint

hostname

public abstract String hostname()

Gets the host name assigned to the endpoint.

Returns:

the host name assigned to the endpoint

listResourceUsage

public abstract PagedIterable<Usage> listResourceUsage()

Lists usage information for the endpoint.

Returns:

usage information for the endpoint

provisioningState

public abstract AfdProvisioningState provisioningState()

Gets the provisioning state reported by the service.

Returns:

the provisioning state reported by the service

purgeContent

public abstract void purgeContent(List<String> contentPaths)

Purges cached content for the endpoint.

Parameters:

contentPaths - paths that should be removed from the cache

purgeContent

public abstract void purgeContent(List<String> contentPaths, List<String> domains)

Purges cached content for the endpoint.

Parameters:

contentPaths - paths that should be removed from the cache
domains - optional list of linked domains to scope the purge to

purgeContentAsync

public abstract Mono<Void> purgeContentAsync(List<String> contentPaths)

Purges cached content for the endpoint asynchronously.

Parameters:

contentPaths - paths that should be removed from the cache

Returns:

a representation of the deferred computation of this call

purgeContentAsync

public abstract Mono<Void> purgeContentAsync(List<String> contentPaths, List<String> domains)

Purges cached content for the endpoint asynchronously.

Parameters:

contentPaths - paths that should be removed from the cache
domains - optional list of linked domains to scope the purge to

Returns:

a representation of the deferred computation of this call

routes

public abstract Map<String,Route> routes()

Gets latest routes by sending http request.

Returns:

routes in this endpoint, indexed by name

validateCustomDomain

public abstract CustomDomainValidationResult validateCustomDomain(String hostName)

Validates that the provided custom domain maps correctly to this endpoint.

Parameters:

hostName - the host name that should point to this endpoint

Returns:

the validation result

validateCustomDomainAsync

public abstract Mono<CustomDomainValidationResult> validateCustomDomainAsync(String hostName)

Validates that the provided custom domain maps correctly to this endpoint asynchronously.

Parameters:

hostName - the host name that should point to this endpoint

Returns:

a representation of the deferred computation of this call

Applies to