198 строки
16 KiB
YAML
198 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration"
|
|
name: "CacheConfiguration"
|
|
nameWithType: "CacheConfiguration"
|
|
summary: "Caching settings for a caching-type route."
|
|
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 **CacheConfiguration**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cdn.models.CacheConfiguration?alt=com.azure.resourcemanager.cdn.models.CacheConfiguration&text=CacheConfiguration\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.CacheConfiguration()"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.CacheConfiguration()"
|
|
name: "CacheConfiguration()"
|
|
nameWithType: "CacheConfiguration.CacheConfiguration()"
|
|
summary: "Creates an instance of Cache<wbr>Configuration class."
|
|
syntax: "public CacheConfiguration()"
|
|
desc: "Creates an instance of CacheConfiguration class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.cacheBehavior()"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.cacheBehavior()"
|
|
name: "cacheBehavior()"
|
|
nameWithType: "CacheConfiguration.cacheBehavior()"
|
|
summary: "Get the cache<wbr>Behavior property: Caching behavior for the requests."
|
|
syntax: "public RuleCacheBehavior cacheBehavior()"
|
|
desc: "Get the cacheBehavior property: Caching behavior for the requests."
|
|
returns:
|
|
description: "the cacheBehavior value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.RuleCacheBehavior?alt=com.azure.resourcemanager.cdn.models.RuleCacheBehavior&text=RuleCacheBehavior\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.cacheDuration()"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.cacheDuration()"
|
|
name: "cacheDuration()"
|
|
nameWithType: "CacheConfiguration.cacheDuration()"
|
|
summary: "Get the cache<wbr>Duration property: The duration for which the content needs to be cached."
|
|
syntax: "public String cacheDuration()"
|
|
desc: "Get the cacheDuration property: The duration for which the content needs to be cached. Allowed format is \\[d.\\]hh:mm:ss."
|
|
returns:
|
|
description: "the cacheDuration value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "CacheConfiguration.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Cache<wbr>Configuration 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 CacheConfiguration fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the CacheConfiguration."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of CacheConfiguration from the JsonReader."
|
|
returns:
|
|
description: "An instance of CacheConfiguration if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CacheConfiguration?alt=com.azure.resourcemanager.cdn.models.CacheConfiguration&text=CacheConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.isCompressionEnabled()"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.isCompressionEnabled()"
|
|
name: "isCompressionEnabled()"
|
|
nameWithType: "CacheConfiguration.isCompressionEnabled()"
|
|
summary: "Get the is<wbr>Compression<wbr>Enabled property: Indicates whether content compression is enabled."
|
|
syntax: "public RuleIsCompressionEnabled isCompressionEnabled()"
|
|
desc: "Get the isCompressionEnabled property: Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB."
|
|
returns:
|
|
description: "the isCompressionEnabled value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.RuleIsCompressionEnabled?alt=com.azure.resourcemanager.cdn.models.RuleIsCompressionEnabled&text=RuleIsCompressionEnabled\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.queryParameters()"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.queryParameters()"
|
|
name: "queryParameters()"
|
|
nameWithType: "CacheConfiguration.queryParameters()"
|
|
summary: "Get the query<wbr>Parameters property: query parameters to include or exclude (comma separated)."
|
|
syntax: "public String queryParameters()"
|
|
desc: "Get the queryParameters property: query parameters to include or exclude (comma separated)."
|
|
returns:
|
|
description: "the queryParameters value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.queryStringCachingBehavior()"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.queryStringCachingBehavior()"
|
|
name: "queryStringCachingBehavior()"
|
|
nameWithType: "CacheConfiguration.queryStringCachingBehavior()"
|
|
summary: "Get the query<wbr>String<wbr>Caching<wbr>Behavior property: Defines how Frontdoor caches requests that include query strings."
|
|
syntax: "public RuleQueryStringCachingBehavior queryStringCachingBehavior()"
|
|
desc: "Get the queryStringCachingBehavior property: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings."
|
|
returns:
|
|
description: "the queryStringCachingBehavior value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.RuleQueryStringCachingBehavior?alt=com.azure.resourcemanager.cdn.models.RuleQueryStringCachingBehavior&text=RuleQueryStringCachingBehavior\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "CacheConfiguration.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.CacheConfiguration.validate()"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.validate()"
|
|
name: "validate()"
|
|
nameWithType: "CacheConfiguration.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withCacheBehavior(com.azure.resourcemanager.cdn.models.RuleCacheBehavior)"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withCacheBehavior(RuleCacheBehavior cacheBehavior)"
|
|
name: "withCacheBehavior(RuleCacheBehavior cacheBehavior)"
|
|
nameWithType: "CacheConfiguration.withCacheBehavior(RuleCacheBehavior cacheBehavior)"
|
|
summary: "Set the cache<wbr>Behavior property: Caching behavior for the requests."
|
|
parameters:
|
|
- description: "the cacheBehavior value to set."
|
|
name: "cacheBehavior"
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.RuleCacheBehavior?alt=com.azure.resourcemanager.cdn.models.RuleCacheBehavior&text=RuleCacheBehavior\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CacheConfiguration withCacheBehavior(RuleCacheBehavior cacheBehavior)"
|
|
desc: "Set the cacheBehavior property: Caching behavior for the requests."
|
|
returns:
|
|
description: "the CacheConfiguration object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CacheConfiguration?alt=com.azure.resourcemanager.cdn.models.CacheConfiguration&text=CacheConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withCacheDuration(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withCacheDuration(String cacheDuration)"
|
|
name: "withCacheDuration(String cacheDuration)"
|
|
nameWithType: "CacheConfiguration.withCacheDuration(String cacheDuration)"
|
|
summary: "Set the cache<wbr>Duration property: The duration for which the content needs to be cached."
|
|
parameters:
|
|
- description: "the cacheDuration value to set."
|
|
name: "cacheDuration"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CacheConfiguration withCacheDuration(String cacheDuration)"
|
|
desc: "Set the cacheDuration property: The duration for which the content needs to be cached. Allowed format is \\[d.\\]hh:mm:ss."
|
|
returns:
|
|
description: "the CacheConfiguration object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CacheConfiguration?alt=com.azure.resourcemanager.cdn.models.CacheConfiguration&text=CacheConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withIsCompressionEnabled(com.azure.resourcemanager.cdn.models.RuleIsCompressionEnabled)"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withIsCompressionEnabled(RuleIsCompressionEnabled isCompressionEnabled)"
|
|
name: "withIsCompressionEnabled(RuleIsCompressionEnabled isCompressionEnabled)"
|
|
nameWithType: "CacheConfiguration.withIsCompressionEnabled(RuleIsCompressionEnabled isCompressionEnabled)"
|
|
summary: "Set the is<wbr>Compression<wbr>Enabled property: Indicates whether content compression is enabled."
|
|
parameters:
|
|
- description: "the isCompressionEnabled value to set."
|
|
name: "isCompressionEnabled"
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.RuleIsCompressionEnabled?alt=com.azure.resourcemanager.cdn.models.RuleIsCompressionEnabled&text=RuleIsCompressionEnabled\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CacheConfiguration withIsCompressionEnabled(RuleIsCompressionEnabled isCompressionEnabled)"
|
|
desc: "Set the isCompressionEnabled property: Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB."
|
|
returns:
|
|
description: "the CacheConfiguration object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CacheConfiguration?alt=com.azure.resourcemanager.cdn.models.CacheConfiguration&text=CacheConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withQueryParameters(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withQueryParameters(String queryParameters)"
|
|
name: "withQueryParameters(String queryParameters)"
|
|
nameWithType: "CacheConfiguration.withQueryParameters(String queryParameters)"
|
|
summary: "Set the query<wbr>Parameters property: query parameters to include or exclude (comma separated)."
|
|
parameters:
|
|
- description: "the queryParameters value to set."
|
|
name: "queryParameters"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CacheConfiguration withQueryParameters(String queryParameters)"
|
|
desc: "Set the queryParameters property: query parameters to include or exclude (comma separated)."
|
|
returns:
|
|
description: "the CacheConfiguration object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CacheConfiguration?alt=com.azure.resourcemanager.cdn.models.CacheConfiguration&text=CacheConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withQueryStringCachingBehavior(com.azure.resourcemanager.cdn.models.RuleQueryStringCachingBehavior)"
|
|
fullName: "com.azure.resourcemanager.cdn.models.CacheConfiguration.withQueryStringCachingBehavior(RuleQueryStringCachingBehavior queryStringCachingBehavior)"
|
|
name: "withQueryStringCachingBehavior(RuleQueryStringCachingBehavior queryStringCachingBehavior)"
|
|
nameWithType: "CacheConfiguration.withQueryStringCachingBehavior(RuleQueryStringCachingBehavior queryStringCachingBehavior)"
|
|
summary: "Set the query<wbr>String<wbr>Caching<wbr>Behavior property: Defines how Frontdoor caches requests that include query strings."
|
|
parameters:
|
|
- description: "the queryStringCachingBehavior value to set."
|
|
name: "queryStringCachingBehavior"
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.RuleQueryStringCachingBehavior?alt=com.azure.resourcemanager.cdn.models.RuleQueryStringCachingBehavior&text=RuleQueryStringCachingBehavior\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CacheConfiguration withQueryStringCachingBehavior(RuleQueryStringCachingBehavior queryStringCachingBehavior)"
|
|
desc: "Set the queryStringCachingBehavior property: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings."
|
|
returns:
|
|
description: "the CacheConfiguration object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CacheConfiguration?alt=com.azure.resourcemanager.cdn.models.CacheConfiguration&text=CacheConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cdn.models.CacheConfiguration?alt=com.azure.resourcemanager.cdn.models.CacheConfiguration&text=CacheConfiguration\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cdn.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cdn:2.42.0
|