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