EndpointPropertiesUpdateParameters Class

Package:

com.azure.resourcemanager.cdn.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cdn:2.53.7

• java.lang.Object
• • com.azure.resourcemanager.cdn.fluent.models.EndpointPropertiesUpdateParameters

Implements

JsonSerializable<EndpointPropertiesUpdateParameters>

public class EndpointPropertiesUpdateParameters
implements JsonSerializable<EndpointPropertiesUpdateParameters>

The JSON object containing endpoint update parameters.

Constructor Summary

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

Method Summary

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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EndpointPropertiesUpdateParameters

public EndpointPropertiesUpdateParameters()

Creates an instance of EndpointPropertiesUpdateParameters class.

Method Details

contentTypesToCompress

public List<String> 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.

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 EndpointPropertiesUpdateParameters fromJson(JsonReader jsonReader)

Reads an instance of EndpointPropertiesUpdateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the EndpointPropertiesUpdateParameters.

geoFilters

public List<GeoFilter> 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.

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.

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.

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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

urlSigningKeys

public List<UrlSigningKey> 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 EndpointPropertiesUpdateParameters withContentTypesToCompress(List<String> 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 EndpointPropertiesUpdateParameters object itself.

withDefaultOriginGroup

public EndpointPropertiesUpdateParameters withDefaultOriginGroup(ResourceReference defaultOriginGroup)

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

Parameters:

defaultOriginGroup - the defaultOriginGroup value to set.

Returns:

the EndpointPropertiesUpdateParameters object itself.

withDeliveryPolicy

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withGeoFilters

public EndpointPropertiesUpdateParameters withGeoFilters(List<GeoFilter> 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 EndpointPropertiesUpdateParameters object itself.

withIsCompressionEnabled

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withIsHttpAllowed

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withIsHttpsAllowed

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withOptimizationType

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withOriginHostHeader

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withOriginPath

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withProbePath

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withQueryStringCachingBehavior

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.

withUrlSigningKeys

public EndpointPropertiesUpdateParameters withUrlSigningKeys(List<UrlSigningKey> urlSigningKeys)

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

Parameters:

urlSigningKeys - the urlSigningKeys value to set.

Returns:

the EndpointPropertiesUpdateParameters object itself.

withWebApplicationFirewallPolicyLink

public EndpointPropertiesUpdateParameters 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 EndpointPropertiesUpdateParameters object itself.