azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

438 строки
40 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters"
name: "EndpointUpdateParameters"
nameWithType: "EndpointUpdateParameters"
summary: "Properties required to create or update an endpoint."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **EndpointUpdateParameters**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.EndpointUpdateParameters()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.EndpointUpdateParameters()"
name: "EndpointUpdateParameters()"
nameWithType: "EndpointUpdateParameters.EndpointUpdateParameters()"
summary: "Creates an instance of Endpoint<wbr>Update<wbr>Parameters class."
syntax: "public EndpointUpdateParameters()"
desc: "Creates an instance of EndpointUpdateParameters class."
methods:
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.contentTypesToCompress()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.contentTypesToCompress()"
name: "contentTypesToCompress()"
nameWithType: "EndpointUpdateParameters.contentTypesToCompress()"
summary: "Get the content<wbr>Types<wbr>ToCompress property: List of content types on which compression applies."
syntax: "public List<String> contentTypesToCompress()"
desc: "Get the contentTypesToCompress property: List of content types on which compression applies. The value should be a valid MIME type."
returns:
description: "the contentTypesToCompress value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.defaultOriginGroup()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.defaultOriginGroup()"
name: "defaultOriginGroup()"
nameWithType: "EndpointUpdateParameters.defaultOriginGroup()"
summary: "Get the default<wbr>Origin<wbr>Group property: A reference to the origin group."
syntax: "public ResourceReference defaultOriginGroup()"
desc: "Get the defaultOriginGroup property: A reference to the origin group."
returns:
description: "the defaultOriginGroup value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.ResourceReference?alt=com.azure.resourcemanager.cdn.models.ResourceReference&text=ResourceReference\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.deliveryPolicy()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.deliveryPolicy()"
name: "deliveryPolicy()"
nameWithType: "EndpointUpdateParameters.deliveryPolicy()"
summary: "Get the delivery<wbr>Policy property: A policy that specifies the delivery rules to be used for an endpoint."
syntax: "public EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy()"
desc: "Get the deliveryPolicy property: A policy that specifies the delivery rules to be used for an endpoint."
returns:
description: "the deliveryPolicy value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersDeliveryPolicy?alt=com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersDeliveryPolicy&text=EndpointPropertiesUpdateParametersDeliveryPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "EndpointUpdateParameters.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Endpoint<wbr>Update<wbr>Parameters from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static EndpointUpdateParameters fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the EndpointUpdateParameters."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of EndpointUpdateParameters from the JsonReader."
returns:
description: "An instance of EndpointUpdateParameters if the JsonReader was pointing to an instance of it, or null if\n it was pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.geoFilters()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.geoFilters()"
name: "geoFilters()"
nameWithType: "EndpointUpdateParameters.geoFilters()"
summary: "Get the geo<wbr>Filters property: List of rules defining the user's geo access within a CDN endpoint."
syntax: "public List<GeoFilter> geoFilters()"
desc: "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:
description: "the geoFilters value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.GeoFilter?alt=com.azure.resourcemanager.cdn.models.GeoFilter&text=GeoFilter\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.isCompressionEnabled()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.isCompressionEnabled()"
name: "isCompressionEnabled()"
nameWithType: "EndpointUpdateParameters.isCompressionEnabled()"
summary: "Get the is<wbr>Compression<wbr>Enabled property: Indicates whether content compression is enabled on CDN."
syntax: "public Boolean isCompressionEnabled()"
desc: "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:
description: "the isCompressionEnabled value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.isHttpAllowed()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.isHttpAllowed()"
name: "isHttpAllowed()"
nameWithType: "EndpointUpdateParameters.isHttpAllowed()"
summary: "Get the is<wbr>Http<wbr>Allowed property: Indicates whether HTTP traffic is allowed on the endpoint."
syntax: "public Boolean isHttpAllowed()"
desc: "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:
description: "the isHttpAllowed value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.isHttpsAllowed()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.isHttpsAllowed()"
name: "isHttpsAllowed()"
nameWithType: "EndpointUpdateParameters.isHttpsAllowed()"
summary: "Get the is<wbr>Https<wbr>Allowed property: Indicates whether HTTPS traffic is allowed on the endpoint."
syntax: "public Boolean isHttpsAllowed()"
desc: "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:
description: "the isHttpsAllowed value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.optimizationType()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.optimizationType()"
name: "optimizationType()"
nameWithType: "EndpointUpdateParameters.optimizationType()"
summary: "Get the optimization<wbr>Type property: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.<wbr>g."
syntax: "public OptimizationType optimizationType()"
desc: "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:
description: "the optimizationType value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.OptimizationType?alt=com.azure.resourcemanager.cdn.models.OptimizationType&text=OptimizationType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.originHostHeader()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.originHostHeader()"
name: "originHostHeader()"
nameWithType: "EndpointUpdateParameters.originHostHeader()"
summary: "Get the origin<wbr>Host<wbr>Header property: The host header value sent to the origin with each request."
syntax: "public String originHostHeader()"
desc: "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:
description: "the originHostHeader value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.originPath()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.originPath()"
name: "originPath()"
nameWithType: "EndpointUpdateParameters.originPath()"
summary: "Get the origin<wbr>Path property: A directory path on the origin that CDN can use to retrieve content from, e.<wbr>g."
syntax: "public String originPath()"
desc: "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:
description: "the originPath value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.probePath()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.probePath()"
name: "probePath()"
nameWithType: "EndpointUpdateParameters.probePath()"
summary: "Get the probe<wbr>Path 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."
syntax: "public String probePath()"
desc: "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:
description: "the probePath value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.queryStringCachingBehavior()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.queryStringCachingBehavior()"
name: "queryStringCachingBehavior()"
nameWithType: "EndpointUpdateParameters.queryStringCachingBehavior()"
summary: "Get the query<wbr>String<wbr>Caching<wbr>Behavior property: Defines how CDN caches requests that include query strings."
syntax: "public QueryStringCachingBehavior queryStringCachingBehavior()"
desc: "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:
description: "the queryStringCachingBehavior value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.QueryStringCachingBehavior?alt=com.azure.resourcemanager.cdn.models.QueryStringCachingBehavior&text=QueryStringCachingBehavior\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.tags()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.tags()"
name: "tags()"
nameWithType: "EndpointUpdateParameters.tags()"
summary: "Get the tags property: Endpoint tags."
syntax: "public Map<String,String> tags()"
desc: "Get the tags property: Endpoint tags."
returns:
description: "the tags value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "EndpointUpdateParameters.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.urlSigningKeys()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.urlSigningKeys()"
name: "urlSigningKeys()"
nameWithType: "EndpointUpdateParameters.urlSigningKeys()"
summary: "Get the url<wbr>Signing<wbr>Keys property: List of keys used to validate the signed URL hashes."
syntax: "public List<UrlSigningKey> urlSigningKeys()"
desc: "Get the urlSigningKeys property: List of keys used to validate the signed URL hashes."
returns:
description: "the urlSigningKeys value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.UrlSigningKey?alt=com.azure.resourcemanager.cdn.models.UrlSigningKey&text=UrlSigningKey\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.validate()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.validate()"
name: "validate()"
nameWithType: "EndpointUpdateParameters.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.webApplicationFirewallPolicyLink()"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.webApplicationFirewallPolicyLink()"
name: "webApplicationFirewallPolicyLink()"
nameWithType: "EndpointUpdateParameters.webApplicationFirewallPolicyLink()"
summary: "Get the web<wbr>Application<wbr>Firewall<wbr>Policy<wbr>Link property: Defines the Web Application Firewall policy for the endpoint (if applicable)."
syntax: "public EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink()"
desc: "Get the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable)."
returns:
description: "the webApplicationFirewallPolicyLink value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink?alt=com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink&text=EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withContentTypesToCompress(java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withContentTypesToCompress(List<String> contentTypesToCompress)"
name: "withContentTypesToCompress(List<String> contentTypesToCompress)"
nameWithType: "EndpointUpdateParameters.withContentTypesToCompress(List<String> contentTypesToCompress)"
summary: "Set the content<wbr>Types<wbr>ToCompress property: List of content types on which compression applies."
parameters:
- description: "the contentTypesToCompress value to set."
name: "contentTypesToCompress"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public EndpointUpdateParameters withContentTypesToCompress(List<String> contentTypesToCompress)"
desc: "Set the contentTypesToCompress property: List of content types on which compression applies. The value should be a valid MIME type."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withDefaultOriginGroup(com.azure.resourcemanager.cdn.models.ResourceReference)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withDefaultOriginGroup(ResourceReference defaultOriginGroup)"
name: "withDefaultOriginGroup(ResourceReference defaultOriginGroup)"
nameWithType: "EndpointUpdateParameters.withDefaultOriginGroup(ResourceReference defaultOriginGroup)"
summary: "Set the default<wbr>Origin<wbr>Group property: A reference to the origin group."
parameters:
- description: "the defaultOriginGroup value to set."
name: "defaultOriginGroup"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.ResourceReference?alt=com.azure.resourcemanager.cdn.models.ResourceReference&text=ResourceReference\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EndpointUpdateParameters withDefaultOriginGroup(ResourceReference defaultOriginGroup)"
desc: "Set the defaultOriginGroup property: A reference to the origin group."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withDeliveryPolicy(com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersDeliveryPolicy)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy)"
name: "withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy)"
nameWithType: "EndpointUpdateParameters.withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy)"
summary: "Set the delivery<wbr>Policy property: A policy that specifies the delivery rules to be used for an endpoint."
parameters:
- description: "the deliveryPolicy value to set."
name: "deliveryPolicy"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersDeliveryPolicy?alt=com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersDeliveryPolicy&text=EndpointPropertiesUpdateParametersDeliveryPolicy\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EndpointUpdateParameters withDeliveryPolicy(EndpointPropertiesUpdateParametersDeliveryPolicy deliveryPolicy)"
desc: "Set the deliveryPolicy property: A policy that specifies the delivery rules to be used for an endpoint."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withGeoFilters(java.util.List<com.azure.resourcemanager.cdn.models.GeoFilter>)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withGeoFilters(List<GeoFilter> geoFilters)"
name: "withGeoFilters(List<GeoFilter> geoFilters)"
nameWithType: "EndpointUpdateParameters.withGeoFilters(List<GeoFilter> geoFilters)"
summary: "Set the geo<wbr>Filters property: List of rules defining the user's geo access within a CDN endpoint."
parameters:
- description: "the geoFilters value to set."
name: "geoFilters"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.GeoFilter?alt=com.azure.resourcemanager.cdn.models.GeoFilter&text=GeoFilter\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public EndpointUpdateParameters withGeoFilters(List<GeoFilter> geoFilters)"
desc: "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/."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withIsCompressionEnabled(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withIsCompressionEnabled(Boolean isCompressionEnabled)"
name: "withIsCompressionEnabled(Boolean isCompressionEnabled)"
nameWithType: "EndpointUpdateParameters.withIsCompressionEnabled(Boolean isCompressionEnabled)"
summary: "Set the is<wbr>Compression<wbr>Enabled property: Indicates whether content compression is enabled on CDN."
parameters:
- description: "the isCompressionEnabled value to set."
name: "isCompressionEnabled"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public EndpointUpdateParameters withIsCompressionEnabled(Boolean isCompressionEnabled)"
desc: "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."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withIsHttpAllowed(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withIsHttpAllowed(Boolean isHttpAllowed)"
name: "withIsHttpAllowed(Boolean isHttpAllowed)"
nameWithType: "EndpointUpdateParameters.withIsHttpAllowed(Boolean isHttpAllowed)"
summary: "Set the is<wbr>Http<wbr>Allowed property: Indicates whether HTTP traffic is allowed on the endpoint."
parameters:
- description: "the isHttpAllowed value to set."
name: "isHttpAllowed"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public EndpointUpdateParameters withIsHttpAllowed(Boolean isHttpAllowed)"
desc: "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."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withIsHttpsAllowed(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withIsHttpsAllowed(Boolean isHttpsAllowed)"
name: "withIsHttpsAllowed(Boolean isHttpsAllowed)"
nameWithType: "EndpointUpdateParameters.withIsHttpsAllowed(Boolean isHttpsAllowed)"
summary: "Set the is<wbr>Https<wbr>Allowed property: Indicates whether HTTPS traffic is allowed on the endpoint."
parameters:
- description: "the isHttpsAllowed value to set."
name: "isHttpsAllowed"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public EndpointUpdateParameters withIsHttpsAllowed(Boolean isHttpsAllowed)"
desc: "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."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withOptimizationType(com.azure.resourcemanager.cdn.models.OptimizationType)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withOptimizationType(OptimizationType optimizationType)"
name: "withOptimizationType(OptimizationType optimizationType)"
nameWithType: "EndpointUpdateParameters.withOptimizationType(OptimizationType optimizationType)"
summary: "Set the optimization<wbr>Type property: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.<wbr>g."
parameters:
- description: "the optimizationType value to set."
name: "optimizationType"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.OptimizationType?alt=com.azure.resourcemanager.cdn.models.OptimizationType&text=OptimizationType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EndpointUpdateParameters withOptimizationType(OptimizationType optimizationType)"
desc: "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."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withOriginHostHeader(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withOriginHostHeader(String originHostHeader)"
name: "withOriginHostHeader(String originHostHeader)"
nameWithType: "EndpointUpdateParameters.withOriginHostHeader(String originHostHeader)"
summary: "Set the origin<wbr>Host<wbr>Header property: The host header value sent to the origin with each request."
parameters:
- description: "the originHostHeader value to set."
name: "originHostHeader"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public EndpointUpdateParameters withOriginHostHeader(String originHostHeader)"
desc: "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."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withOriginPath(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withOriginPath(String originPath)"
name: "withOriginPath(String originPath)"
nameWithType: "EndpointUpdateParameters.withOriginPath(String originPath)"
summary: "Set the origin<wbr>Path property: A directory path on the origin that CDN can use to retrieve content from, e.<wbr>g."
parameters:
- description: "the originPath value to set."
name: "originPath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public EndpointUpdateParameters withOriginPath(String originPath)"
desc: "Set the originPath property: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withProbePath(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withProbePath(String probePath)"
name: "withProbePath(String probePath)"
nameWithType: "EndpointUpdateParameters.withProbePath(String probePath)"
summary: "Set the probe<wbr>Path 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."
parameters:
- description: "the probePath value to set."
name: "probePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public EndpointUpdateParameters withProbePath(String probePath)"
desc: "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."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withQueryStringCachingBehavior(com.azure.resourcemanager.cdn.models.QueryStringCachingBehavior)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior)"
name: "withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior)"
nameWithType: "EndpointUpdateParameters.withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior)"
summary: "Set the query<wbr>String<wbr>Caching<wbr>Behavior property: Defines how CDN caches requests that include query strings."
parameters:
- description: "the queryStringCachingBehavior value to set."
name: "queryStringCachingBehavior"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.QueryStringCachingBehavior?alt=com.azure.resourcemanager.cdn.models.QueryStringCachingBehavior&text=QueryStringCachingBehavior\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EndpointUpdateParameters withQueryStringCachingBehavior(QueryStringCachingBehavior queryStringCachingBehavior)"
desc: "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."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withTags(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withTags(Map<String,String> tags)"
name: "withTags(Map<String,String> tags)"
nameWithType: "EndpointUpdateParameters.withTags(Map<String,String> tags)"
summary: "Set the tags property: Endpoint tags."
parameters:
- description: "the tags value to set."
name: "tags"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public EndpointUpdateParameters withTags(Map<String,String> tags)"
desc: "Set the tags property: Endpoint tags."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withUrlSigningKeys(java.util.List<com.azure.resourcemanager.cdn.models.UrlSigningKey>)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withUrlSigningKeys(List<UrlSigningKey> urlSigningKeys)"
name: "withUrlSigningKeys(List<UrlSigningKey> urlSigningKeys)"
nameWithType: "EndpointUpdateParameters.withUrlSigningKeys(List<UrlSigningKey> urlSigningKeys)"
summary: "Set the url<wbr>Signing<wbr>Keys property: List of keys used to validate the signed URL hashes."
parameters:
- description: "the urlSigningKeys value to set."
name: "urlSigningKeys"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.UrlSigningKey?alt=com.azure.resourcemanager.cdn.models.UrlSigningKey&text=UrlSigningKey\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public EndpointUpdateParameters withUrlSigningKeys(List<UrlSigningKey> urlSigningKeys)"
desc: "Set the urlSigningKeys property: List of keys used to validate the signed URL hashes."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withWebApplicationFirewallPolicyLink(com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink)"
fullName: "com.azure.resourcemanager.cdn.models.EndpointUpdateParameters.withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)"
name: "withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)"
nameWithType: "EndpointUpdateParameters.withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)"
summary: "Set the web<wbr>Application<wbr>Firewall<wbr>Policy<wbr>Link property: Defines the Web Application Firewall policy for the endpoint (if applicable)."
parameters:
- description: "the webApplicationFirewallPolicyLink value to set."
name: "webApplicationFirewallPolicyLink"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink?alt=com.azure.resourcemanager.cdn.models.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink&text=EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EndpointUpdateParameters withWebApplicationFirewallPolicyLink(EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink webApplicationFirewallPolicyLink)"
desc: "Set the webApplicationFirewallPolicyLink property: Defines the Web Application Firewall policy for the endpoint (if applicable)."
returns:
description: "the EndpointUpdateParameters object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Properties required to create or update an endpoint."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.EndpointUpdateParameters?alt=com.azure.resourcemanager.cdn.models.EndpointUpdateParameters&text=EndpointUpdateParameters\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.cdn.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cdn:2.42.0