EndpointInner Class

Package:

com.azure.resourcemanager.cdn.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cdn:2.47.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.cdn.fluent.models.EndpointInner

public final class EndpointInner
extends Resource

CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.

Constructor Summary

Constructor	Description
EndpointInner()	Creates an instance of EndpointInner class.

Method Summary

Modifier and Type	Method and Description
List<String>	contentTypesToCompress() Get the contentTypesToCompress property: List of content types on which compression applies.
List<DeepCreatedCustomDomain>	customDomains() Get the customDomains property: The custom domains under the endpoint.
ResourceReference	defaultOriginGroup() Get the defaultOriginGroup property: A reference to the origin group.
EndpointPropertiesUpdateParametersDeliveryPolicy	deliveryPolicy() Get the deliveryPolicy property: A policy that specifies the delivery rules to be used for an endpoint.
static EndpointInner	fromJson(JsonReader jsonReader) Reads an instance of EndpointInner from the JsonReader.
List<GeoFilter>	geoFilters() Get the geoFilters property: List of rules defining the user's geo access within a CDN endpoint.
String	hostname() Get the hostname property: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g.
String	id() Get the id property: Fully qualified resource Id for the resource.
Boolean	isCompressionEnabled() Get the isCompressionEnabled property: Indicates whether content compression is enabled on CDN.
Boolean	isHttpAllowed() Get the isHttpAllowed property: Indicates whether HTTP traffic is allowed on the endpoint.
Boolean	isHttpsAllowed() Get the isHttpsAllowed property: Indicates whether HTTPS traffic is allowed on the endpoint.
String	name() Get the name property: The name of the resource.
OptimizationType	optimizationType() Get the optimizationType property: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g.
List<DeepCreatedOriginGroup>	originGroups() Get the originGroups property: The origin groups comprising of origins that are used for load balancing the traffic based on availability.
String	originHostHeader() Get the originHostHeader property: The host header value sent to the origin with each request.
String	originPath() Get the originPath property: A directory path on the origin that CDN can use to retrieve content from, e.g.
List<DeepCreatedOrigin>	origins() Get the origins property: The source of the content being delivered via CDN.
String	probePath() Get the probePath property: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN.
EndpointProvisioningState	provisioningState() Get the provisioningState property: Provisioning status of the endpoint.
QueryStringCachingBehavior	queryStringCachingBehavior() Get the queryStringCachingBehavior property: Defines how CDN caches requests that include query strings.
EndpointResourceState	resourceState() Get the resourceState property: Resource status of the endpoint.
SystemData	systemData() Get the systemData property: Read only system data.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
List<UrlSigningKey>	urlSigningKeys() Get the urlSigningKeys property: List of keys used to validate the signed URL hashes.
void	validate() Validates the instance.
EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink	webApplicationFirewallPolicyLink() Get the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable).
EndpointInner	withContentTypesToCompress(List<String> contentTypesToCompress) Set the contentTypesToCompress property: List of content types on which compression applies.
EndpointInner	withDefaultOriginGroup(ResourceReference defaultOriginGroup) Set the defaultOriginGroup property: A reference to the origin group.
EndpointInner	withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy) Set the deliveryPolicy property: A policy that specifies the delivery rules to be used for an endpoint.
EndpointInner	withGeoFilters(List<GeoFilter> geoFilters) Set the geoFilters property: List of rules defining the user's geo access within a CDN endpoint.
EndpointInner	withIsCompressionEnabled(Boolean isCompressionEnabled) Set the isCompressionEnabled property: Indicates whether content compression is enabled on CDN.
EndpointInner	withIsHttpAllowed(Boolean isHttpAllowed) Set the isHttpAllowed property: Indicates whether HTTP traffic is allowed on the endpoint.
EndpointInner	withIsHttpsAllowed(Boolean isHttpsAllowed) Set the isHttpsAllowed property: Indicates whether HTTPS traffic is allowed on the endpoint.
EndpointInner	withLocation(String location)
EndpointInner	withOptimizationType(OptimizationType optimizationType) Set the optimizationType property: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g.
EndpointInner	withOriginGroups(List<DeepCreatedOriginGroup> originGroups) Set the originGroups property: The origin groups comprising of origins that are used for load balancing the traffic based on availability.
EndpointInner	withOriginHostHeader(String originHostHeader) Set the originHostHeader property: The host header value sent to the origin with each request.
EndpointInner	withOriginPath(String originPath) Set the originPath property: A directory path on the origin that CDN can use to retrieve content from, e.g.
EndpointInner	withOrigins(List<DeepCreatedOrigin> origins) Set the origins property: The source of the content being delivered via CDN.
EndpointInner	withProbePath(String probePath) Set the probePath property: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN.
EndpointInner	withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior) Set the queryStringCachingBehavior property: Defines how CDN caches requests that include query strings.
EndpointInner	withTags(Map<String,String> tags)
EndpointInner	withUrlSigningKeys(List<UrlSigningKey> urlSigningKeys) Set the urlSigningKeys property: List of keys used to validate the signed URL hashes.
EndpointInner	withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink) Set the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable).

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EndpointInner

public EndpointInner()

Creates an instance of EndpointInner class.

Method Details

contentTypesToCompress

public List contentTypesToCompress()

Get the contentTypesToCompress property: List of content types on which compression applies. The value should be a valid MIME type.

Returns:

the contentTypesToCompress value.

customDomains

public List customDomains()

Get the customDomains property: The custom domains under the endpoint.

Returns:

the customDomains value.

defaultOriginGroup

public ResourceReference defaultOriginGroup()

Get the defaultOriginGroup property: A reference to the origin group.

Returns:

the defaultOriginGroup value.

deliveryPolicy

public EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy()

Get the deliveryPolicy property: A policy that specifies the delivery rules to be used for an endpoint.

Returns:

the deliveryPolicy value.

fromJson

public static EndpointInner fromJson(JsonReader jsonReader)

Reads an instance of EndpointInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of EndpointInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

geoFilters

public List geoFilters()

Get the geoFilters property: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.

Returns:

the geoFilters value.

hostname

public String hostname()

Get the hostname property: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.

Returns:

the hostname value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

EndpointInner.id()

Returns:

the id value.

isCompressionEnabled

public Boolean isCompressionEnabled()

Get the isCompressionEnabled property: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.

Returns:

the isCompressionEnabled value.

isHttpAllowed

public Boolean isHttpAllowed()

Get the isHttpAllowed property: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

Returns:

the isHttpAllowed value.

isHttpsAllowed

public Boolean isHttpsAllowed()

Get the isHttpsAllowed property: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

Returns:

the isHttpsAllowed value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

EndpointInner.name()

Returns:

the name value.

optimizationType

public OptimizationType optimizationType()

Get the optimizationType property: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.

Returns:

the optimizationType value.

originGroups

public List originGroups()

Get the originGroups property: The origin groups comprising of origins that are used for load balancing the traffic based on availability.

Returns:

the originGroups value.

originHostHeader

public String originHostHeader()

Get the originHostHeader property: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.

Returns:

the originHostHeader value.

originPath

public String originPath()

Get the originPath property: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

Returns:

the originPath value.

origins

public List origins()

Get the origins property: The source of the content being delivered via CDN.

Returns:

the origins value.

probePath

public String probePath()

Get the probePath property: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.

Returns:

the probePath value.

provisioningState

public EndpointProvisioningState provisioningState()

Get the provisioningState property: Provisioning status of the endpoint.

Returns:

the provisioningState value.

queryStringCachingBehavior

public QueryStringCachingBehavior queryStringCachingBehavior()

Get the queryStringCachingBehavior property: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.

Returns:

the queryStringCachingBehavior value.

resourceState

public EndpointResourceState resourceState()

Get the resourceState property: Resource status of the endpoint.

Returns:

the resourceState value.

systemData

public SystemData systemData()

Get the systemData property: Read only system data.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EndpointInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

EndpointInner.type()

Returns:

the type value.

urlSigningKeys

public List urlSigningKeys()

Get the urlSigningKeys property: List of keys used to validate the signed URL hashes.

Returns:

the urlSigningKeys value.

validate

public void validate()

Validates the instance.

webApplicationFirewallPolicyLink

public EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink()

Get the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable).

Returns:

the webApplicationFirewallPolicyLink value.

withContentTypesToCompress

public EndpointInner withContentTypesToCompress(List contentTypesToCompress)

Set the contentTypesToCompress property: List of content types on which compression applies. The value should be a valid MIME type.

Parameters:

contentTypesToCompress - the contentTypesToCompress value to set.

Returns:

the EndpointInner object itself.

withDefaultOriginGroup

public EndpointInner withDefaultOriginGroup(ResourceReference defaultOriginGroup)

Set the defaultOriginGroup property: A reference to the origin group.

Parameters:

defaultOriginGroup - the defaultOriginGroup value to set.

Returns:

the EndpointInner object itself.

withDeliveryPolicy

public EndpointInner withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy)

Set the deliveryPolicy property: A policy that specifies the delivery rules to be used for an endpoint.

Parameters:

deliveryPolicy - the deliveryPolicy value to set.

Returns:

the EndpointInner object itself.

withGeoFilters

public EndpointInner withGeoFilters(List geoFilters)

Set the geoFilters property: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.

Parameters:

geoFilters - the geoFilters value to set.

Returns:

the EndpointInner object itself.

withIsCompressionEnabled

public EndpointInner withIsCompressionEnabled(Boolean isCompressionEnabled)

Set the isCompressionEnabled property: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.

Parameters:

isCompressionEnabled - the isCompressionEnabled value to set.

Returns:

the EndpointInner object itself.

withIsHttpAllowed

public EndpointInner withIsHttpAllowed(Boolean isHttpAllowed)

Set the isHttpAllowed property: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

Parameters:

isHttpAllowed - the isHttpAllowed value to set.

Returns:

the EndpointInner object itself.

withIsHttpsAllowed

public EndpointInner withIsHttpsAllowed(Boolean isHttpsAllowed)

Set the isHttpsAllowed property: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.

Parameters:

isHttpsAllowed - the isHttpsAllowed value to set.

Returns:

the EndpointInner object itself.

withLocation

public EndpointInner withLocation(String location)

Overrides:

EndpointInner.withLocation(String location)

Parameters:

location

withOptimizationType

public EndpointInner withOptimizationType(OptimizationType optimizationType)

Set the optimizationType property: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.

Parameters:

optimizationType - the optimizationType value to set.

Returns:

the EndpointInner object itself.

withOriginGroups

public EndpointInner withOriginGroups(List originGroups)

Set the originGroups property: The origin groups comprising of origins that are used for load balancing the traffic based on availability.

Parameters:

originGroups - the originGroups value to set.

Returns:

the EndpointInner object itself.

withOriginHostHeader

public EndpointInner withOriginHostHeader(String originHostHeader)

Set the originHostHeader property: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.

Parameters:

originHostHeader - the originHostHeader value to set.

Returns:

the EndpointInner object itself.

withOriginPath

public EndpointInner withOriginPath(String originPath)

Set the originPath property: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

Parameters:

originPath - the originPath value to set.

Returns:

the EndpointInner object itself.

withOrigins

public EndpointInner withOrigins(List origins)

Set the origins property: The source of the content being delivered via CDN.

Parameters:

origins - the origins value to set.

Returns:

the EndpointInner object itself.

withProbePath

public EndpointInner withProbePath(String probePath)

Set the probePath property: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.

Parameters:

probePath - the probePath value to set.

Returns:

the EndpointInner object itself.

withQueryStringCachingBehavior

public EndpointInner withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior)

Set the queryStringCachingBehavior property: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.

Parameters:

queryStringCachingBehavior - the queryStringCachingBehavior value to set.

Returns:

the EndpointInner object itself.

withTags

public EndpointInner withTags(Map tags)

Overrides:

EndpointInner.withTags(Map<String,String> tags)

Parameters:

tags

withUrlSigningKeys

public EndpointInner withUrlSigningKeys(List urlSigningKeys)

Set the urlSigningKeys property: List of keys used to validate the signed URL hashes.

Parameters:

urlSigningKeys - the urlSigningKeys value to set.

Returns:

the EndpointInner object itself.

withWebApplicationFirewallPolicyLink

public EndpointInner withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)

Set the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable).

Parameters:

webApplicationFirewallPolicyLink - the webApplicationFirewallPolicyLink value to set.

Returns:

the EndpointInner object itself.