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

198 строки
16 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cdn.models.PolicySettings"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings"
name: "PolicySettings"
nameWithType: "PolicySettings"
summary: "Defines contents of a web application firewall global configuration."
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 **PolicySettings**</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.PolicySettings?alt=com.azure.resourcemanager.cdn.models.PolicySettings&text=PolicySettings\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.PolicySettings()"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.PolicySettings()"
name: "PolicySettings()"
nameWithType: "PolicySettings.PolicySettings()"
summary: "Creates an instance of Policy<wbr>Settings class."
syntax: "public PolicySettings()"
desc: "Creates an instance of PolicySettings class."
methods:
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.defaultCustomBlockResponseBody()"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.defaultCustomBlockResponseBody()"
name: "defaultCustomBlockResponseBody()"
nameWithType: "PolicySettings.defaultCustomBlockResponseBody()"
summary: "Get the default<wbr>Custom<wbr>Block<wbr>Response<wbr>Body property: If the action type is block, customer can override the response body."
syntax: "public String defaultCustomBlockResponseBody()"
desc: "Get the defaultCustomBlockResponseBody property: If the action type is block, customer can override the response body. The body must be specified in base64 encoding."
returns:
description: "the defaultCustomBlockResponseBody value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.defaultCustomBlockResponseStatusCode()"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.defaultCustomBlockResponseStatusCode()"
name: "defaultCustomBlockResponseStatusCode()"
nameWithType: "PolicySettings.defaultCustomBlockResponseStatusCode()"
summary: "Get the default<wbr>Custom<wbr>Block<wbr>Response<wbr>Status<wbr>Code property: If the action type is block, this field defines the default customer overridable http response status code."
syntax: "public PolicySettingsDefaultCustomBlockResponseStatusCode defaultCustomBlockResponseStatusCode()"
desc: "Get the defaultCustomBlockResponseStatusCode property: If the action type is block, this field defines the default customer overridable http response status code."
returns:
description: "the defaultCustomBlockResponseStatusCode value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicySettingsDefaultCustomBlockResponseStatusCode?alt=com.azure.resourcemanager.cdn.models.PolicySettingsDefaultCustomBlockResponseStatusCode&text=PolicySettingsDefaultCustomBlockResponseStatusCode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.defaultRedirectUrl()"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.defaultRedirectUrl()"
name: "defaultRedirectUrl()"
nameWithType: "PolicySettings.defaultRedirectUrl()"
summary: "Get the default<wbr>Redirect<wbr>Url property: If action type is redirect, this field represents the default redirect URL for the client."
syntax: "public String defaultRedirectUrl()"
desc: "Get the defaultRedirectUrl property: If action type is redirect, this field represents the default redirect URL for the client."
returns:
description: "the defaultRedirectUrl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.enabledState()"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.enabledState()"
name: "enabledState()"
nameWithType: "PolicySettings.enabledState()"
summary: "Get the enabled<wbr>State property: describes if the policy is in enabled state or disabled state."
syntax: "public PolicyEnabledState enabledState()"
desc: "Get the enabledState property: describes if the policy is in enabled state or disabled state."
returns:
description: "the enabledState value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicyEnabledState?alt=com.azure.resourcemanager.cdn.models.PolicyEnabledState&text=PolicyEnabledState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "PolicySettings.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Policy<wbr>Settings 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 PolicySettings fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the PolicySettings."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of PolicySettings from the JsonReader."
returns:
description: "An instance of PolicySettings 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.PolicySettings?alt=com.azure.resourcemanager.cdn.models.PolicySettings&text=PolicySettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.mode()"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.mode()"
name: "mode()"
nameWithType: "PolicySettings.mode()"
summary: "Get the mode property: Describes if it is in detection mode or prevention mode at policy level."
syntax: "public PolicyMode mode()"
desc: "Get the mode property: Describes if it is in detection mode or prevention mode at policy level."
returns:
description: "the mode value."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicyMode?alt=com.azure.resourcemanager.cdn.models.PolicyMode&text=PolicyMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "PolicySettings.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.PolicySettings.validate()"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.validate()"
name: "validate()"
nameWithType: "PolicySettings.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.withDefaultCustomBlockResponseBody(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.withDefaultCustomBlockResponseBody(String defaultCustomBlockResponseBody)"
name: "withDefaultCustomBlockResponseBody(String defaultCustomBlockResponseBody)"
nameWithType: "PolicySettings.withDefaultCustomBlockResponseBody(String defaultCustomBlockResponseBody)"
summary: "Set the default<wbr>Custom<wbr>Block<wbr>Response<wbr>Body property: If the action type is block, customer can override the response body."
parameters:
- description: "the defaultCustomBlockResponseBody value to set."
name: "defaultCustomBlockResponseBody"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PolicySettings withDefaultCustomBlockResponseBody(String defaultCustomBlockResponseBody)"
desc: "Set the defaultCustomBlockResponseBody property: If the action type is block, customer can override the response body. The body must be specified in base64 encoding."
returns:
description: "the PolicySettings object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicySettings?alt=com.azure.resourcemanager.cdn.models.PolicySettings&text=PolicySettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.withDefaultCustomBlockResponseStatusCode(com.azure.resourcemanager.cdn.models.PolicySettingsDefaultCustomBlockResponseStatusCode)"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.withDefaultCustomBlockResponseStatusCode(PolicySettingsDefaultCustomBlockResponseStatusCode defaultCustomBlockResponseStatusCode)"
name: "withDefaultCustomBlockResponseStatusCode(PolicySettingsDefaultCustomBlockResponseStatusCode defaultCustomBlockResponseStatusCode)"
nameWithType: "PolicySettings.withDefaultCustomBlockResponseStatusCode(PolicySettingsDefaultCustomBlockResponseStatusCode defaultCustomBlockResponseStatusCode)"
summary: "Set the default<wbr>Custom<wbr>Block<wbr>Response<wbr>Status<wbr>Code property: If the action type is block, this field defines the default customer overridable http response status code."
parameters:
- description: "the defaultCustomBlockResponseStatusCode value to set."
name: "defaultCustomBlockResponseStatusCode"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicySettingsDefaultCustomBlockResponseStatusCode?alt=com.azure.resourcemanager.cdn.models.PolicySettingsDefaultCustomBlockResponseStatusCode&text=PolicySettingsDefaultCustomBlockResponseStatusCode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PolicySettings withDefaultCustomBlockResponseStatusCode(PolicySettingsDefaultCustomBlockResponseStatusCode defaultCustomBlockResponseStatusCode)"
desc: "Set the defaultCustomBlockResponseStatusCode property: If the action type is block, this field defines the default customer overridable http response status code."
returns:
description: "the PolicySettings object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicySettings?alt=com.azure.resourcemanager.cdn.models.PolicySettings&text=PolicySettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.withDefaultRedirectUrl(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.withDefaultRedirectUrl(String defaultRedirectUrl)"
name: "withDefaultRedirectUrl(String defaultRedirectUrl)"
nameWithType: "PolicySettings.withDefaultRedirectUrl(String defaultRedirectUrl)"
summary: "Set the default<wbr>Redirect<wbr>Url property: If action type is redirect, this field represents the default redirect URL for the client."
parameters:
- description: "the defaultRedirectUrl value to set."
name: "defaultRedirectUrl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PolicySettings withDefaultRedirectUrl(String defaultRedirectUrl)"
desc: "Set the defaultRedirectUrl property: If action type is redirect, this field represents the default redirect URL for the client."
returns:
description: "the PolicySettings object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicySettings?alt=com.azure.resourcemanager.cdn.models.PolicySettings&text=PolicySettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.withEnabledState(com.azure.resourcemanager.cdn.models.PolicyEnabledState)"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.withEnabledState(PolicyEnabledState enabledState)"
name: "withEnabledState(PolicyEnabledState enabledState)"
nameWithType: "PolicySettings.withEnabledState(PolicyEnabledState enabledState)"
summary: "Set the enabled<wbr>State property: describes if the policy is in enabled state or disabled state."
parameters:
- description: "the enabledState value to set."
name: "enabledState"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicyEnabledState?alt=com.azure.resourcemanager.cdn.models.PolicyEnabledState&text=PolicyEnabledState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PolicySettings withEnabledState(PolicyEnabledState enabledState)"
desc: "Set the enabledState property: describes if the policy is in enabled state or disabled state."
returns:
description: "the PolicySettings object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicySettings?alt=com.azure.resourcemanager.cdn.models.PolicySettings&text=PolicySettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.PolicySettings.withMode(com.azure.resourcemanager.cdn.models.PolicyMode)"
fullName: "com.azure.resourcemanager.cdn.models.PolicySettings.withMode(PolicyMode mode)"
name: "withMode(PolicyMode mode)"
nameWithType: "PolicySettings.withMode(PolicyMode mode)"
summary: "Set the mode property: Describes if it is in detection mode or prevention mode at policy level."
parameters:
- description: "the mode value to set."
name: "mode"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicyMode?alt=com.azure.resourcemanager.cdn.models.PolicyMode&text=PolicyMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PolicySettings withMode(PolicyMode mode)"
desc: "Set the mode property: Describes if it is in detection mode or prevention mode at policy level."
returns:
description: "the PolicySettings object itself."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.PolicySettings?alt=com.azure.resourcemanager.cdn.models.PolicySettings&text=PolicySettings\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines contents of a web application firewall global configuration."
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.PolicySettings?alt=com.azure.resourcemanager.cdn.models.PolicySettings&text=PolicySettings\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.cdn.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cdn:2.42.0