azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

331 строка
21 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint"
name: "CdnEndpoint"
nameWithType: "CdnEndpoint"
summary: "An immutable client-side representation of an Azure CDN endpoint."
syntax: "public interface **CdnEndpoint**</br> extends <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.ExternalChildResource?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.ExternalChildResource&text=ExternalChildResource\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CdnEndpoint?alt=com.azure.resourcemanager.cdn.models.CdnEndpoint&text=CdnEndpoint\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.resourcemanager.cdn.models.CdnProfile?alt=com.azure.resourcemanager.cdn.models.CdnProfile&text=CdnProfile\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel?alt=com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel&text=HasInnerModel\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.fluent.models.EndpointInner?alt=com.azure.resourcemanager.cdn.fluent.models.EndpointInner&text=EndpointInner\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.contentTypesToCompress()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.contentTypesToCompress()"
name: "contentTypesToCompress()"
nameWithType: "CdnEndpoint.contentTypesToCompress()"
modifiers:
- "abstract"
syntax: "public abstract Set<String> contentTypesToCompress()"
returns:
description: "content types to be compressed"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.customDomains()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.customDomains()"
name: "customDomains()"
nameWithType: "CdnEndpoint.customDomains()"
modifiers:
- "abstract"
syntax: "public abstract Set<String> customDomains()"
returns:
description: "custom domains associated with this endpoint"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.geoFilters()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.geoFilters()"
name: "geoFilters()"
nameWithType: "CdnEndpoint.geoFilters()"
modifiers:
- "abstract"
syntax: "public abstract Collection<GeoFilter> geoFilters()"
returns:
description: "list of Geo filters"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.GeoFilter?alt=com.azure.resourcemanager.cdn.models.GeoFilter&text=GeoFilter\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.hostname()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.hostname()"
name: "hostname()"
nameWithType: "CdnEndpoint.hostname()"
modifiers:
- "abstract"
syntax: "public abstract String hostname()"
returns:
description: "endpoint host name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.httpPort()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.httpPort()"
name: "httpPort()"
nameWithType: "CdnEndpoint.httpPort()"
modifiers:
- "abstract"
syntax: "public abstract int httpPort()"
returns:
description: "HTTP port value"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.httpsPort()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.httpsPort()"
name: "httpsPort()"
nameWithType: "CdnEndpoint.httpsPort()"
modifiers:
- "abstract"
syntax: "public abstract int httpsPort()"
returns:
description: "HTTPS port value"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.isCompressionEnabled()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.isCompressionEnabled()"
name: "isCompressionEnabled()"
nameWithType: "CdnEndpoint.isCompressionEnabled()"
modifiers:
- "abstract"
syntax: "public abstract boolean isCompressionEnabled()"
returns:
description: "true if content compression is enabled, otherwise false"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.isHttpAllowed()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.isHttpAllowed()"
name: "isHttpAllowed()"
nameWithType: "CdnEndpoint.isHttpAllowed()"
modifiers:
- "abstract"
syntax: "public abstract boolean isHttpAllowed()"
returns:
description: "true if HTTP traffic is allowed, otherwise false."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.isHttpsAllowed()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.isHttpsAllowed()"
name: "isHttpsAllowed()"
nameWithType: "CdnEndpoint.isHttpsAllowed()"
modifiers:
- "abstract"
syntax: "public abstract boolean isHttpsAllowed()"
returns:
description: "true if HTTPS traffic is allowed, otherwise false"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.listResourceUsage()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.listResourceUsage()"
name: "listResourceUsage()"
nameWithType: "CdnEndpoint.listResourceUsage()"
summary: "Checks the quota and usage of geo filters and custom domains under the current endpoint."
modifiers:
- "abstract"
syntax: "public abstract PagedIterable<ResourceUsage> listResourceUsage()"
desc: "Checks the quota and usage of geo filters and custom domains under the current endpoint."
returns:
description: "list of quotas and usages of geo filters and custom domains under the current endpoint"
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.ResourceUsage?alt=com.azure.resourcemanager.cdn.models.ResourceUsage&text=ResourceUsage\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.loadContent(java.util.Set<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.loadContent(Set<String> contentPaths)"
name: "loadContent(Set<String> contentPaths)"
nameWithType: "CdnEndpoint.loadContent(Set<String> contentPaths)"
summary: "Forcibly preloads the content of the CDN endpoint."
modifiers:
- "abstract"
parameters:
- description: "the file paths to the content to be loaded"
name: "contentPaths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public abstract void loadContent(Set<String> contentPaths)"
desc: "Forcibly preloads the content of the CDN endpoint.\n\nNote: this is supported for Verizon profiles only."
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.loadContentAsync(java.util.Set<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.loadContentAsync(Set<String> contentPaths)"
name: "loadContentAsync(Set<String> contentPaths)"
nameWithType: "CdnEndpoint.loadContentAsync(Set<String> contentPaths)"
summary: "Forcibly preloads the content of the CDN endpoint asynchronously."
modifiers:
- "abstract"
parameters:
- description: "the file paths to the content to be loaded"
name: "contentPaths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public abstract Mono<Void> loadContentAsync(Set<String> contentPaths)"
desc: "Forcibly preloads the content of the CDN endpoint asynchronously.\n\nNote: this is supported for Verizon profiles only."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.optimizationType()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.optimizationType()"
name: "optimizationType()"
nameWithType: "CdnEndpoint.optimizationType()"
modifiers:
- "abstract"
syntax: "public abstract String optimizationType()"
returns:
description: "optimization type"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.originHostHeader()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.originHostHeader()"
name: "originHostHeader()"
nameWithType: "CdnEndpoint.originHostHeader()"
modifiers:
- "abstract"
syntax: "public abstract String originHostHeader()"
returns:
description: "origin host header"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.originHostName()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.originHostName()"
name: "originHostName()"
nameWithType: "CdnEndpoint.originHostName()"
modifiers:
- "abstract"
syntax: "public abstract String originHostName()"
returns:
description: "origin host name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.originPath()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.originPath()"
name: "originPath()"
nameWithType: "CdnEndpoint.originPath()"
modifiers:
- "abstract"
syntax: "public abstract String originPath()"
returns:
description: "origin path"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.provisioningState()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.provisioningState()"
name: "provisioningState()"
nameWithType: "CdnEndpoint.provisioningState()"
modifiers:
- "abstract"
syntax: "public abstract String provisioningState()"
returns:
description: "endpoint provisioning state"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.purgeContent(java.util.Set<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.purgeContent(Set<String> contentPaths)"
name: "purgeContent(Set<String> contentPaths)"
nameWithType: "CdnEndpoint.purgeContent(Set<String> contentPaths)"
summary: "Forcibly purges the content of the CDN endpoint."
modifiers:
- "abstract"
parameters:
- description: "the paths to the content to be purged, which can be file paths or directory wild cards."
name: "contentPaths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public abstract void purgeContent(Set<String> contentPaths)"
desc: "Forcibly purges the content of the CDN endpoint."
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.purgeContentAsync(java.util.Set<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.purgeContentAsync(Set<String> contentPaths)"
name: "purgeContentAsync(Set<String> contentPaths)"
nameWithType: "CdnEndpoint.purgeContentAsync(Set<String> contentPaths)"
summary: "Forcibly purges the content of the CDN endpoint asynchronously."
modifiers:
- "abstract"
parameters:
- description: "the paths to the content to be purged, which can be file paths or directory wild cards."
name: "contentPaths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public abstract Mono<Void> purgeContentAsync(Set<String> contentPaths)"
desc: "Forcibly purges the content of the CDN endpoint asynchronously."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.queryStringCachingBehavior()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.queryStringCachingBehavior()"
name: "queryStringCachingBehavior()"
nameWithType: "CdnEndpoint.queryStringCachingBehavior()"
modifiers:
- "abstract"
syntax: "public abstract QueryStringCachingBehavior queryStringCachingBehavior()"
returns:
description: "query string caching behavior"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.QueryStringCachingBehavior?alt=com.azure.resourcemanager.cdn.models.QueryStringCachingBehavior&text=QueryStringCachingBehavior\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.resourceState()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.resourceState()"
name: "resourceState()"
nameWithType: "CdnEndpoint.resourceState()"
modifiers:
- "abstract"
syntax: "public abstract EndpointResourceState resourceState()"
returns:
description: "endpoint state"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointResourceState?alt=com.azure.resourcemanager.cdn.models.EndpointResourceState&text=EndpointResourceState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.standardRulesEngineRules()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.standardRulesEngineRules()"
name: "standardRulesEngineRules()"
nameWithType: "CdnEndpoint.standardRulesEngineRules()"
modifiers:
- "abstract"
syntax: "public abstract Map<String,DeliveryRule> standardRulesEngineRules()"
returns:
description: "the map of the Standard rules engine rules, indexed by rule name\n (note: this is only available for Standard Microsoft CDN Sku endpoints)"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.resourcemanager.cdn.models.DeliveryRule?alt=com.azure.resourcemanager.cdn.models.DeliveryRule&text=DeliveryRule\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.start()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.start()"
name: "start()"
nameWithType: "CdnEndpoint.start()"
summary: "Starts the CDN endpoint, if it is stopped."
modifiers:
- "abstract"
syntax: "public abstract void start()"
desc: "Starts the CDN endpoint, if it is stopped."
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.startAsync()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.startAsync()"
name: "startAsync()"
nameWithType: "CdnEndpoint.startAsync()"
summary: "Starts the CDN endpoint asynchronously, if it is stopped."
modifiers:
- "abstract"
syntax: "public abstract Mono<Void> startAsync()"
desc: "Starts the CDN endpoint asynchronously, if it is stopped."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.stop()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.stop()"
name: "stop()"
nameWithType: "CdnEndpoint.stop()"
summary: "Stops the CDN endpoint, if it is running."
modifiers:
- "abstract"
syntax: "public abstract void stop()"
desc: "Stops the CDN endpoint, if it is running."
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.stopAsync()"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.stopAsync()"
name: "stopAsync()"
nameWithType: "CdnEndpoint.stopAsync()"
summary: "Stops the CDN endpoint asynchronously, if it is running."
modifiers:
- "abstract"
syntax: "public abstract Mono<Void> stopAsync()"
desc: "Stops the CDN endpoint asynchronously, if it is running."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.validateCustomDomain(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.validateCustomDomain(String hostName)"
name: "validateCustomDomain(String hostName)"
nameWithType: "CdnEndpoint.validateCustomDomain(String hostName)"
summary: "Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint."
modifiers:
- "abstract"
parameters:
- description: "the host name, which must be a domain name, of the custom domain"
name: "hostName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract CustomDomainValidationResult validateCustomDomain(String hostName)"
desc: "Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint."
returns:
description: "the result of the action, if successful."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomDomainValidationResult?alt=com.azure.resourcemanager.cdn.models.CustomDomainValidationResult&text=CustomDomainValidationResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnEndpoint.validateCustomDomainAsync(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnEndpoint.validateCustomDomainAsync(String hostName)"
name: "validateCustomDomainAsync(String hostName)"
nameWithType: "CdnEndpoint.validateCustomDomainAsync(String hostName)"
summary: "Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint asynchronously."
modifiers:
- "abstract"
parameters:
- description: "the host name, which must be a domain name, of the custom domain"
name: "hostName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<CustomDomainValidationResult> validateCustomDomainAsync(String hostName)"
desc: "Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS for current endpoint asynchronously."
returns:
description: "an observable of the result"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CustomDomainValidationResult?alt=com.azure.resourcemanager.cdn.models.CustomDomainValidationResult&text=CustomDomainValidationResult\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "An immutable client-side representation of an Azure CDN endpoint."
implements:
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.ExternalChildResource?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.ExternalChildResource&text=ExternalChildResource\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CdnEndpoint?alt=com.azure.resourcemanager.cdn.models.CdnEndpoint&text=CdnEndpoint\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.resourcemanager.cdn.models.CdnProfile?alt=com.azure.resourcemanager.cdn.models.CdnProfile&text=CdnProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel?alt=com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel&text=HasInnerModel\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.fluent.models.EndpointInner?alt=com.azure.resourcemanager.cdn.fluent.models.EndpointInner&text=EndpointInner\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.cdn.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cdn:2.42.0