POST v1/bunits/{bunitId}/orainbucketpresets
Create a new oRain bucket preset
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit the preset should be related to | integer |
Required |
Body Parameters
The preset to be created
ORainBucketPreset| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
string |
None. |
|
BurnMode |
Specifies the mode used for burning. Options: "UDF", "Stream" Default: "UDF" |
ORainBurnMode |
None. |
LockBurnMode |
boolean |
None. |
|
BurnType |
Specifies the strategy type for burn operations. Options: "finishedBurn", "manualTrigger", "cron" Default: "finishedBurn" |
ORainBurnType |
None. |
LockBurnType |
boolean |
None. |
|
BurnCron |
Expression for scheduled burn operations. If BurnType is "cron", this expression is used to schedule the cleanup. "0 0 3 * * ?" https://en.wikipedia.org/wiki/Cron |
string |
None. |
LockBurnCron |
boolean |
None. |
|
CleanType |
Specifies the strategy type for cleanup operations. Options: "burnedClean", "manualTrigger", "cron" Default: "burnedClean" |
ORainCleanType |
None. |
LockCleanType |
boolean |
None. |
|
CleanCron |
Expression for scheduled cleanup operations. If CleanType is "cron", this expression is used to schedule the cleanup. "0 0 2 * * ?" https://en.wikipedia.org/wiki/Cron |
string |
None. |
LockCleanCron |
boolean |
None. |
|
RaidType |
Defines the RAID array strategy type. Options: "5+1", "11+1" |
ORainRaidType |
None. |
LockRaidType |
boolean |
None. |
|
MinBurnCapacityGB |
Defines the minimum burn capacity in GB. |
decimal number |
None. |
LockMinBurnCapacityGB |
boolean |
None. |
|
DiscType |
Specifies the type of optical disc used to store data of the bucket. Options: DVD-R$4.7G: DVD-R disc, 4.7 GB. DVD+R$4.7G: DVD+R disc, 4.7 GB. BD-R$25G: BD-R disc, 25 GB. BD-RE$25G: BD-RE disc, 25 GB, rewritable Blu-ray disc. BD-R$50G: BD-R disc, 50 GB. BD-R$100G: BD-R disc, 100 GB. BD-R$128G: BD-R disc, 128 GB. BD-R$200G: BD-R disc, 200 GB (double-sided disc). Default: "BD-R$200G" |
ORainDiscType |
None. |
LockDiscType |
boolean |
None. |
|
AllowLogicalDiscAdjustment |
Whether dynamic adjustment of logical discs is allowed. Default is false. |
boolean |
None. |
LockAllowLogicalDiscAdjustment |
boolean |
None. |
|
RetainDiscAfterMigration |
Whether to retain the disc after migration is complete. false means the disc should be returned, true means it should not be returned. Default is false. oRain: IsFetchFinishNotReturnDisk |
boolean |
None. |
LockRetainDiscAfterMigration |
boolean |
None. |
|
DelayedArchivingDays |
Specifies the number of days to delay the archiving process |
integer |
None. |
LockDelayedArchivingDays |
boolean |
None. |
|
EnableDelayedArchive |
Whether to enable archive delay |
boolean |
None. |
LockEnableDelayedArchive |
boolean |
None. |
|
VersioningState |
Indicates whether S3 Versioning is Disabled, Enabled or Suspended. Once it is enabled, it cannot be disabled, but suspended - which effectively disables it for new objects, but keeps existing object versions. Thus, following transitions are allowed: Disabled > Enabled > Suspended > Enabled. |
VersioningState |
None. |
LockVersioningState |
boolean |
None. |
|
Inherited |
Whether or not the bucket is related to the business unit currently given or one of it's ancestors |
boolean |
None. |
BusinessUnit |
BusinessUnit |
None. |
|
BusinessUnitId |
integer |
None. |
|
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The preset with created information
ORainBucketPreset| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
string |
None. |
|
BurnMode |
Specifies the mode used for burning. Options: "UDF", "Stream" Default: "UDF" |
ORainBurnMode |
None. |
LockBurnMode |
boolean |
None. |
|
BurnType |
Specifies the strategy type for burn operations. Options: "finishedBurn", "manualTrigger", "cron" Default: "finishedBurn" |
ORainBurnType |
None. |
LockBurnType |
boolean |
None. |
|
BurnCron |
Expression for scheduled burn operations. If BurnType is "cron", this expression is used to schedule the cleanup. "0 0 3 * * ?" https://en.wikipedia.org/wiki/Cron |
string |
None. |
LockBurnCron |
boolean |
None. |
|
CleanType |
Specifies the strategy type for cleanup operations. Options: "burnedClean", "manualTrigger", "cron" Default: "burnedClean" |
ORainCleanType |
None. |
LockCleanType |
boolean |
None. |
|
CleanCron |
Expression for scheduled cleanup operations. If CleanType is "cron", this expression is used to schedule the cleanup. "0 0 2 * * ?" https://en.wikipedia.org/wiki/Cron |
string |
None. |
LockCleanCron |
boolean |
None. |
|
RaidType |
Defines the RAID array strategy type. Options: "5+1", "11+1" |
ORainRaidType |
None. |
LockRaidType |
boolean |
None. |
|
MinBurnCapacityGB |
Defines the minimum burn capacity in GB. |
decimal number |
None. |
LockMinBurnCapacityGB |
boolean |
None. |
|
DiscType |
Specifies the type of optical disc used to store data of the bucket. Options: DVD-R$4.7G: DVD-R disc, 4.7 GB. DVD+R$4.7G: DVD+R disc, 4.7 GB. BD-R$25G: BD-R disc, 25 GB. BD-RE$25G: BD-RE disc, 25 GB, rewritable Blu-ray disc. BD-R$50G: BD-R disc, 50 GB. BD-R$100G: BD-R disc, 100 GB. BD-R$128G: BD-R disc, 128 GB. BD-R$200G: BD-R disc, 200 GB (double-sided disc). Default: "BD-R$200G" |
ORainDiscType |
None. |
LockDiscType |
boolean |
None. |
|
AllowLogicalDiscAdjustment |
Whether dynamic adjustment of logical discs is allowed. Default is false. |
boolean |
None. |
LockAllowLogicalDiscAdjustment |
boolean |
None. |
|
RetainDiscAfterMigration |
Whether to retain the disc after migration is complete. false means the disc should be returned, true means it should not be returned. Default is false. oRain: IsFetchFinishNotReturnDisk |
boolean |
None. |
LockRetainDiscAfterMigration |
boolean |
None. |
|
DelayedArchivingDays |
Specifies the number of days to delay the archiving process |
integer |
None. |
LockDelayedArchivingDays |
boolean |
None. |
|
EnableDelayedArchive |
Whether to enable archive delay |
boolean |
None. |
LockEnableDelayedArchive |
boolean |
None. |
|
VersioningState |
Indicates whether S3 Versioning is Disabled, Enabled or Suspended. Once it is enabled, it cannot be disabled, but suspended - which effectively disables it for new objects, but keeps existing object versions. Thus, following transitions are allowed: Disabled > Enabled > Suspended > Enabled. |
VersioningState |
None. |
LockVersioningState |
boolean |
None. |
|
Inherited |
Whether or not the bucket is related to the business unit currently given or one of it's ancestors |
boolean |
None. |
BusinessUnit |
BusinessUnit |
None. |
|
BusinessUnitId |
integer |
None. |
|
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.