partitions
Overview
Name | partitions |
Type | Resource |
Id | sumologic.partitions.partitions |
Fields
Name | Datatype | Description |
---|---|---|
id | string | Unique identifier for the partition. |
name | string | The name of the partition. |
analyticsTier | string | The Data Tier where the data in the partition will reside. Possible values are: 1. continuous 2. frequent 3. infrequent Note: The "infrequent" and "frequent" tiers are only available to Cloud Flex Credits Enterprise Suite accounts. |
createdAt | string | Creation timestamp in UTC in RFC3339 format. |
createdBy | string | Identifier of the user who created the resource. |
dataForwardingId | string | Id of the data forwarding configuration to be used by the partition. |
indexType | string | This has the value DefaultIndex , AuditIndex or Partition depending upon the type of partition. |
isActive | boolean | This has the value true if the partition is active and false if it has been decommissioned. |
isCompliant | boolean | Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later. |
modifiedAt | string | Last modification timestamp in UTC. |
modifiedBy | string | Identifier of the user who last modified the resource. |
newRetentionPeriod | integer | If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time. |
retentionEffectiveAt | string | When the newRetentionPeriod will become effective in UTC format. |
retentionPeriod | integer | The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled. |
routingExpression | string | The query that defines the data to be included in the partition. |
totalBytes | integer | Size of data in partition in bytes. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
getPartition | SELECT | id, region | Get a partition with the given identifier from the organization. |
listPartitions | SELECT | region | Get a list of all partitions in the organization. The response is paginated with a default limit of 100 partitions per page. |
createPartition | INSERT | data__name, data__routingExpression, region | Create a new partition. |
updatePartition | EXEC | id, region | Update an existing partition in the organization. |