Databucket

databucket

The databucket object is a basic container that holds data, typically organized through the use of data partitions.

Contents

Attributes

Caption Name Type Is Array Default Description
Created Time created_time Timestamp The time when the databucket was known to have been created.
Data Classification data_classification Data Classification The Data Classification object includes information about data classification levels and data category types.
Description desc String The description of the databucket.
File file File A file within a databucket.
Groups groups Group The group names to which the databucket belongs.
Modified Time modified_time Timestamp The most recent time when any changes, updates, or modifications were made within the databucket.
Name name String The databucket name.
Raw Data raw_data JSON The event data as received from the event source.
Record ID record_id String Unique identifier for the object
Size size Long The size of the databucket in bytes.
Type type String The databucket type.
Type ID type_id Integer The normalized identifier of the databucket type.
0
Unknown
1
S3
2
Azure Blob
3
GCP Bucket
99
Other
Unique ID uid String The unique identifier of the databucket.
Unmapped Data unmapped Unmapped The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.

Context

Databucket

JSON

            
{
  "caption": "Databucket",
  "description": "The databucket object is a basic container that holds data, typically organized through the use of data partitions.",
  "extends": "_entity",
  "name": "databucket",
  "profiles": [
    "data_classification"
  ],
  "attributes": {
    "$include": [
      "profiles/data_classification.json"
    ],
    "created_time": {
      "description": "The time when the databucket was known to have been created.",
      "requirement": "optional",
      "caption": "Created Time",
      "type": "timestamp_t"
    },
    "modified_time": {
      "description": "The most recent time when any changes, updates, or modifications were made within the databucket.",
      "requirement": "optional",
      "caption": "Modified Time",
      "type": "timestamp_t"
    },
    "desc": {
      "caption": "Description",
      "description": "The description of the databucket.",
      "requirement": "optional",
      "type": "string_t"
    },
    "size": {
      "description": "The size of the databucket in bytes.",
      "requirement": "optional",
      "caption": "Size",
      "type": "long_t"
    },
    "file": {
      "description": "A file within a databucket.",
      "requirement": "optional",
      "caption": "File",
      "type": "file"
    },
    "groups": {
      "description": "The group names to which the databucket belongs.",
      "requirement": "optional",
      "caption": "Groups",
      "is_array": true,
      "type": "group"
    },
    "type": {
      "description": "The databucket type.",
      "requirement": "recommended",
      "caption": "Type",
      "type": "string_t"
    },
    "type_id": {
      "description": "The normalized identifier of the databucket type.",
      "requirement": "required",
      "enum": {
        "0": {
          "caption": "Unknown",
          "description": "The type is unknown."
        },
        "1": {
          "caption": "S3"
        },
        "2": {
          "caption": "Azure Blob"
        },
        "3": {
          "caption": "GCP Bucket"
        },
        "99": {
          "caption": "Other",
          "description": "The type is not mapped. See the <code>type</code> attribute, which contains a data source specific value."
        }
      },
      "caption": "Type ID",
      "sibling": "type",
      "type": "integer_t"
    },
    "name": {
      "description": "The databucket name.",
      "requirement": "recommended",
      "caption": "Name",
      "type": "string_t"
    },
    "uid": {
      "description": "The unique identifier of the databucket.",
      "requirement": "recommended",
      "caption": "Unique ID",
      "type": "string_t"
    },
    "data_classification": {
      "group": "context",
      "requirement": "recommended",
      "caption": "Data Classification",
      "description": "The Data Classification object includes information about data classification levels and data category types.",
      "type": "data_classification"
    },
    "raw_data": {
      "group": "context",
      "caption": "Raw Data",
      "description": "The event data as received from the event source.",
      "type": "json_t"
    },
    "record_id": {
      "description": "Unique identifier for the object",
      "group": "primary",
      "requirement": "required",
      "caption": "Record ID",
      "type": "string_t"
    },
    "unmapped": {
      "caption": "Unmapped Data",
      "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
      "type": "unmapped",
      "is_array": true
    }
  },
  "constraints": {
    "at_least_one": [
      "name",
      "uid"
    ]
  }
}