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