EndpointUpdateParameters Class

Package:

com.microsoft.azure.management.cdn

Maven Artifact:

com.microsoft.azure:azure-mgmt-cdn:1.41.4

• java.lang.Object
• • com.microsoft.azure.management.cdn.EndpointUpdateParameters

public class EndpointUpdateParameters

Properties required to create or update an endpoint.

Constructor Summary

Constructor	Description
EndpointUpdateParameters()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	contentTypesToCompress() Get list of content types on which compression applies.
ResourceReference	defaultOriginGroup() Get a reference to the origin group.
EndpointPropertiesUpdateParametersDeliveryPolicy	deliveryPolicy() Get a policy that specifies the delivery rules to be used for an endpoint.
java.util.List<GeoFilter>	geoFilters() Get list of rules defining the user's geo access within a CDN endpoint.
java.lang.Boolean	isCompressionEnabled() Get indicates whether content compression is enabled on CDN.
java.lang.Boolean	isHttpAllowed() Get indicates whether HTTP traffic is allowed on the endpoint.
java.lang.Boolean	isHttpsAllowed() Get indicates whether HTTPS traffic is allowed on the endpoint.
OptimizationType	optimizationType() Get specifies what scenario the customer wants this CDN endpoint to optimize for, e.g.
java.lang.String	originHostHeader() Get the host header value sent to the origin with each request.
java.lang.String	originPath() Get a directory path on the origin that CDN can use to retrieve content from, e.g.
java.lang.String	probePath() Get 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.
QueryStringCachingBehavior	queryStringCachingBehavior() Get defines how CDN caches requests that include query strings.
java.util.Map<java.lang.String,java.lang.String>	tags() Get endpoint tags.
java.util.List<UrlSigningKey>	urlSigningKeys() Get list of keys used to validate the signed URL hashes.
EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink	webApplicationFirewallPolicyLink() Get defines the Web Application Firewall policy for the endpoint (if applicable).
EndpointUpdateParameters	withContentTypesToCompress(List<String> contentTypesToCompress) Set list of content types on which compression applies.
EndpointUpdateParameters	withDefaultOriginGroup(ResourceReference defaultOriginGroup) Set a reference to the origin group.
EndpointUpdateParameters	withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy) Set a policy that specifies the delivery rules to be used for an endpoint.
EndpointUpdateParameters	withGeoFilters(List<GeoFilter> geoFilters) Set list of rules defining the user's geo access within a CDN endpoint.
EndpointUpdateParameters	withIsCompressionEnabled(Boolean isCompressionEnabled) Set indicates whether content compression is enabled on CDN.
EndpointUpdateParameters	withIsHttpAllowed(Boolean isHttpAllowed) Set indicates whether HTTP traffic is allowed on the endpoint.
EndpointUpdateParameters	withIsHttpsAllowed(Boolean isHttpsAllowed) Set indicates whether HTTPS traffic is allowed on the endpoint.
EndpointUpdateParameters	withOptimizationType(OptimizationType optimizationType) Set specifies what scenario the customer wants this CDN endpoint to optimize for, e.g.
EndpointUpdateParameters	withOriginHostHeader(String originHostHeader) Set the host header value sent to the origin with each request.
EndpointUpdateParameters	withOriginPath(String originPath) Set a directory path on the origin that CDN can use to retrieve content from, e.g.
EndpointUpdateParameters	withProbePath(String probePath) Set 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.
EndpointUpdateParameters	withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior) Set defines how CDN caches requests that include query strings.
EndpointUpdateParameters	withTags(Map<String,String> tags) Set endpoint tags.
EndpointUpdateParameters	withUrlSigningKeys(List<UrlSigningKey> urlSigningKeys) Set list of keys used to validate the signed URL hashes.
EndpointUpdateParameters	withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink) Set defines the Web Application Firewall policy for the endpoint (if applicable).

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

EndpointUpdateParameters

public EndpointUpdateParameters()

Method Details

contentTypesToCompress

public List contentTypesToCompress()

Get list of content types on which compression applies. The value should be a valid MIME type.

Returns:

the contentTypesToCompress value

defaultOriginGroup

public ResourceReference defaultOriginGroup()

Get a reference to the origin group.

Returns:

the defaultOriginGroup value

deliveryPolicy

public EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy()

Get a policy that specifies the delivery rules to be used for an endpoint.

Returns:

the deliveryPolicy value

geoFilters

public List geoFilters()

Get 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

isCompressionEnabled

public Boolean isCompressionEnabled()

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

optimizationType

public OptimizationType optimizationType()

Get 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. Possible values include: 'GeneralWebDelivery', 'GeneralMediaStreaming', 'VideoOnDemandMediaStreaming', 'LargeFileDownload', 'DynamicSiteAcceleration'.

Returns:

the optimizationType value

originHostHeader

public String originHostHeader()

Get 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 a directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

Returns:

the originPath value

probePath

public String probePath()

Get 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

queryStringCachingBehavior

public QueryStringCachingBehavior queryStringCachingBehavior()

Get 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. Possible values include: 'IgnoreQueryString', 'BypassCaching', 'UseQueryString', 'NotSet'.

Returns:

the queryStringCachingBehavior value

tags

public Map tags()

Get endpoint tags.

Returns:

the tags value

urlSigningKeys

public List urlSigningKeys()

Get list of keys used to validate the signed URL hashes.

Returns:

the urlSigningKeys value

webApplicationFirewallPolicyLink

public EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink()

Get defines the Web Application Firewall policy for the endpoint (if applicable).

Returns:

the webApplicationFirewallPolicyLink value

withContentTypesToCompress

public EndpointUpdateParameters withContentTypesToCompress(List contentTypesToCompress)

Set 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 EndpointUpdateParameters object itself.

withDefaultOriginGroup

public EndpointUpdateParameters withDefaultOriginGroup(ResourceReference defaultOriginGroup)

Set a reference to the origin group.

Parameters:

defaultOriginGroup - the defaultOriginGroup value to set

Returns:

the EndpointUpdateParameters object itself.

withDeliveryPolicy

public EndpointUpdateParameters withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy)

Set a policy that specifies the delivery rules to be used for an endpoint.

Parameters:

deliveryPolicy - the deliveryPolicy value to set

Returns:

the EndpointUpdateParameters object itself.

withGeoFilters

public EndpointUpdateParameters withGeoFilters(List geoFilters)

Set 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 EndpointUpdateParameters object itself.

withIsCompressionEnabled

public EndpointUpdateParameters withIsCompressionEnabled(Boolean isCompressionEnabled)

Set 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 EndpointUpdateParameters object itself.

withIsHttpAllowed

public EndpointUpdateParameters withIsHttpAllowed(Boolean isHttpAllowed)

Set 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 EndpointUpdateParameters object itself.

withIsHttpsAllowed

public EndpointUpdateParameters withIsHttpsAllowed(Boolean isHttpsAllowed)

Set 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 EndpointUpdateParameters object itself.

withOptimizationType

public EndpointUpdateParameters withOptimizationType(OptimizationType optimizationType)

Set 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. Possible values include: 'GeneralWebDelivery', 'GeneralMediaStreaming', 'VideoOnDemandMediaStreaming', 'LargeFileDownload', 'DynamicSiteAcceleration'.

Parameters:

optimizationType - the optimizationType value to set

Returns:

the EndpointUpdateParameters object itself.

withOriginHostHeader

public EndpointUpdateParameters withOriginHostHeader(String originHostHeader)

Set 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 EndpointUpdateParameters object itself.

withOriginPath

public EndpointUpdateParameters withOriginPath(String originPath)

Set 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 EndpointUpdateParameters object itself.

withProbePath

public EndpointUpdateParameters withProbePath(String probePath)

Set 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 EndpointUpdateParameters object itself.

withQueryStringCachingBehavior

public EndpointUpdateParameters withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior)

Set 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. Possible values include: 'IgnoreQueryString', 'BypassCaching', 'UseQueryString', 'NotSet'.

Parameters:

queryStringCachingBehavior - the queryStringCachingBehavior value to set

Returns:

the EndpointUpdateParameters object itself.

withTags

public EndpointUpdateParameters withTags(Map tags)

Set endpoint tags.

Parameters:

tags - the tags value to set

Returns:

the EndpointUpdateParameters object itself.

withUrlSigningKeys

public EndpointUpdateParameters withUrlSigningKeys(List urlSigningKeys)

Set list of keys used to validate the signed URL hashes.

Parameters:

urlSigningKeys - the urlSigningKeys value to set

Returns:

the EndpointUpdateParameters object itself.

withWebApplicationFirewallPolicyLink

public EndpointUpdateParameters withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)

Set defines the Web Application Firewall policy for the endpoint (if applicable).

Parameters:

webApplicationFirewallPolicyLink - the webApplicationFirewallPolicyLink value to set

Returns:

the EndpointUpdateParameters object itself.