Skip to main content

Variable: DataPatternPatchRequestSchema

const DataPatternPatchRequestSchema: ZodObject<{
  name: ZodString;
  type: ZodEnum<["predefined", "custom", "file_property"]>;
  detection_config: ZodObject<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<["low", "medium", "high"]>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<["low", "medium", "high"]>, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<["low", "medium", "high"]>, "many">>>;
  }, ZodTypeAny, "passthrough">>;
  description: ZodOptional<ZodNullable<ZodString>>;
  matching_rules: ZodOptional<ZodNullable<ZodObject<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<{
        regex: ...;
        weight: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<{
        comparisonOperatorType: ...;
        name: ...;
        type: ...;
        value: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
  }, ZodTypeAny, "passthrough">>>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  }, ZodTypeAny, "passthrough">>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
  name: ZodString;
  type: ZodEnum<["predefined", "custom", "file_property"]>;
  detection_config: ZodObject<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<["low", "medium", "high"]>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<[..., ..., ...]>, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<[..., ..., ...]>, "many">>>;
  }, ZodTypeAny, "passthrough">>;
  description: ZodOptional<ZodNullable<ZodString>>;
  matching_rules: ZodOptional<ZodNullable<ZodObject<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     regexes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     regexes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     compliance: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     geography: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     compliance: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     geography: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
  name: ZodString;
  type: ZodEnum<["predefined", "custom", "file_property"]>;
  detection_config: ZodObject<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<["low", "medium", "high"]>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<[..., ..., ...]>, "many">>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     technique: ZodEnum<["edm", "document_fingerprint", "trainable_classifier", "ml_document", "regex", "weighted_regex", "ml", "titus_tag", "wildfire", "file_property", "dictionary", "pab", "document_classifier"]>;
     supported_confidence_levels: ZodOptional<ZodNullable<ZodArray<ZodEnum<[..., ..., ...]>, "many">>>;
  }, ZodTypeAny, "passthrough">>;
  description: ZodOptional<ZodNullable<ZodString>>;
  matching_rules: ZodOptional<ZodNullable<ZodObject<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     regexes: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     regexes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     delimiter: ZodOptional<ZodNullable<ZodString>>;
     proximity_distance: ZodOptional<ZodNullable<ZodNumber>>;
     proximity_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     regexes: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     metadata_criteria: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  tags: ZodOptional<ZodNullable<ZodObject<{
     classification: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     compliance: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     geography: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     compliance: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     geography: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     classification: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     compliance: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     geography: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/models/dlp-data-pattern.ts:140

Request payload for PATCH (JSON Merge Patch, RFC 7396).

Spec marks detection_config, name, and type as required even on patch — they cannot be cleared, but every other field may be omitted (leave unchanged) or sent as null (clear).