azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.cdn.models.CustomRule.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cdn.models.CustomRule"
fullName: "com.azure.resourcemanager.cdn.models.CustomRule"
name: "CustomRule"
nameWithType: "CustomRule"
summary: "Defines the common attributes for a custom rule that can be included in a waf policy."
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 class **CustomRule**"
constructors:
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.CustomRule()"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.CustomRule()"
  name: "CustomRule()"
  nameWithType: "CustomRule.CustomRule()"
  syntax: "public CustomRule()"
methods:
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.action()"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.action()"
  name: "action()"
  nameWithType: "CustomRule.action()"
  summary: "Get the action property: Describes what action to be applied when rule matches."
  syntax: "public ActionType action()"
  desc: "Get the action property: Describes what action to be applied when rule matches."
  returns:
    description: "the action value."
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.ActionType?alt=com.azure.resourcemanager.cdn.models.ActionType&text=ActionType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.enabledState()"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.enabledState()"
  name: "enabledState()"
  nameWithType: "CustomRule.enabledState()"
  summary: "Get the enabled<wbr>State property: Describes if the custom rule is in enabled or disabled state."
  syntax: "public CustomRuleEnabledState enabledState()"
  desc: "Get the enabledState property: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified."
  returns:
    description: "the enabledState value."
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomRuleEnabledState?alt=com.azure.resourcemanager.cdn.models.CustomRuleEnabledState&text=CustomRuleEnabledState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.matchConditions()"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.matchConditions()"
  name: "matchConditions()"
  nameWithType: "CustomRule.matchConditions()"
  summary: "Get the match<wbr>Conditions property: List of match conditions."
  syntax: "public List<MatchCondition> matchConditions()"
  desc: "Get the matchConditions property: List of match conditions."
  returns:
    description: "the matchConditions 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.MatchCondition?alt=com.azure.resourcemanager.cdn.models.MatchCondition&text=MatchCondition\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.name()"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.name()"
  name: "name()"
  nameWithType: "CustomRule.name()"
  summary: "Get the name property: Defines the name of the custom rule."
  syntax: "public String name()"
  desc: "Get the name property: Defines the name of the custom rule."
  returns:
    description: "the name value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.priority()"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.priority()"
  name: "priority()"
  nameWithType: "CustomRule.priority()"
  summary: "Get the priority property: Defines in what order this rule be evaluated in the overall list of custom rules."
  syntax: "public int priority()"
  desc: "Get the priority property: Defines in what order this rule be evaluated in the overall list of custom rules."
  returns:
    description: "the priority value."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.validate()"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.validate()"
  name: "validate()"
  nameWithType: "CustomRule.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.withAction(com.azure.resourcemanager.cdn.models.ActionType)"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.withAction(ActionType action)"
  name: "withAction(ActionType action)"
  nameWithType: "CustomRule.withAction(ActionType action)"
  summary: "Set the action property: Describes what action to be applied when rule matches."
  parameters:
  - description: "the action value to set."
    name: "action"
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.ActionType?alt=com.azure.resourcemanager.cdn.models.ActionType&text=ActionType\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CustomRule withAction(ActionType action)"
  desc: "Set the action property: Describes what action to be applied when rule matches."
  returns:
    description: "the CustomRule object itself."
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomRule?alt=com.azure.resourcemanager.cdn.models.CustomRule&text=CustomRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.withEnabledState(com.azure.resourcemanager.cdn.models.CustomRuleEnabledState)"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.withEnabledState(CustomRuleEnabledState enabledState)"
  name: "withEnabledState(CustomRuleEnabledState enabledState)"
  nameWithType: "CustomRule.withEnabledState(CustomRuleEnabledState enabledState)"
  summary: "Set the enabled<wbr>State property: Describes if the custom rule is in enabled or disabled state."
  parameters:
  - description: "the enabledState value to set."
    name: "enabledState"
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomRuleEnabledState?alt=com.azure.resourcemanager.cdn.models.CustomRuleEnabledState&text=CustomRuleEnabledState\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CustomRule withEnabledState(CustomRuleEnabledState enabledState)"
  desc: "Set the enabledState property: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified."
  returns:
    description: "the CustomRule object itself."
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomRule?alt=com.azure.resourcemanager.cdn.models.CustomRule&text=CustomRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.withMatchConditions(java.util.List<com.azure.resourcemanager.cdn.models.MatchCondition>)"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.withMatchConditions(List<MatchCondition> matchConditions)"
  name: "withMatchConditions(List<MatchCondition> matchConditions)"
  nameWithType: "CustomRule.withMatchConditions(List<MatchCondition> matchConditions)"
  summary: "Set the match<wbr>Conditions property: List of match conditions."
  parameters:
  - description: "the matchConditions value to set."
    name: "matchConditions"
    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.MatchCondition?alt=com.azure.resourcemanager.cdn.models.MatchCondition&text=MatchCondition\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public CustomRule withMatchConditions(List<MatchCondition> matchConditions)"
  desc: "Set the matchConditions property: List of match conditions."
  returns:
    description: "the CustomRule object itself."
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomRule?alt=com.azure.resourcemanager.cdn.models.CustomRule&text=CustomRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.withName(java.lang.String)"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.withName(String name)"
  name: "withName(String name)"
  nameWithType: "CustomRule.withName(String name)"
  summary: "Set the name property: Defines the name of the custom rule."
  parameters:
  - description: "the name value to set."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public CustomRule withName(String name)"
  desc: "Set the name property: Defines the name of the custom rule."
  returns:
    description: "the CustomRule object itself."
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomRule?alt=com.azure.resourcemanager.cdn.models.CustomRule&text=CustomRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CustomRule.withPriority(int)"
  fullName: "com.azure.resourcemanager.cdn.models.CustomRule.withPriority(int priority)"
  name: "withPriority(int priority)"
  nameWithType: "CustomRule.withPriority(int priority)"
  summary: "Set the priority property: Defines in what order this rule be evaluated in the overall list of custom rules."
  parameters:
  - description: "the priority value to set."
    name: "priority"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public CustomRule withPriority(int priority)"
  desc: "Set the priority property: Defines in what order this rule be evaluated in the overall list of custom rules."
  returns:
    description: "the CustomRule object itself."
    type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomRule?alt=com.azure.resourcemanager.cdn.models.CustomRule&text=CustomRule\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines the common attributes for a custom rule that can be included in a waf policy."
metadata: {}
package: "com.azure.resourcemanager.cdn.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cdn:2.24.0