namespaceDefaults

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The namespaceDefaults data type describes the namespaceDefaults resource.

Properties

The table below describes the properties included in the namespaceDefaults data type.

Property Date Type Description Notes
allowErasureCoding Boolean

Specifies the default setting for whether new namespaces allow erasure coding. Valid values are:

true
The namespace allows erasure coding.
false
The namespace does not allow erasure coding.

The default is false.

This property is valid on a POST request only if the tenant for which you’re specifying namespace defaults is allowed to manage erasure coding for its namespaces.

You can set the value of this property to true on a POST request only if cloud optimization is already set as the default for new namespaces or if the optimizedFor property is set to true in the same request.

This property is returned by a GET request only if the tenant for which you’re specifying namespace defaults is allowed to manage erasure coding for its namespaces.

description String

Specifies the default description for new HCP namespaces. This description is optional. The default is no description.

To remove a description from the namespace defaults, specify the description property with no value.

directoryUsage String

Specifies whether new cloud-optimized namespaces are balanced/unbalanced by default. Valid values are:

Balanced
The directory usage is configured for balanced mode. A well distributed directory structure is required to avoid hot spotting and ensure optimal performance.
Unbalanced
The directory usage is configured for unbalanced mode. Optimal performance is not dependent upon a directory structure.
Default
The directory usage setting for the namespace is determined by the system-level setting for this property.

The default value is Default. The values are not case sensitive.

 
dpl String

Deprecated. Namespace DPL is now a service plan function.

This property is ignored on a POST request. In response to a GET request, the value of this property is always Dynamic.

effectiveDpl String

Deprecated. Namespace DPL is now a service plan function.

This property is not valid on a POST request and is returned only by a verbose GET request. In response to a verbose GET request, the value of this property is always Dynamic.

enterpriseMode Boolean

Specifies the default retention mode for new HCP namespaces. Valid values are:

true
The namespace is in enterprise mode.
false
The namespace is in compliance mode.

The default is true.

In enterprise mode, privileged deletes are allowed, retention class durations can be shortened, and retention classes can be deleted. In compliance mode, these activities are not allowed.

This property is valid on a POST request and returned by a GET request only if the tenant for which you’re specifying namespace defaults is allowed to set the retention mode for its namespaces.

hardQuota String

Specifies the default hard quota for new HCP namespaces.

The hard quota is the total amount of space allocated to the namespace. This is the space available for storing objects, including object data, metadata, and the redundant data required to satisfy the namespace service plan.

Valid values are decimal numbers with up to two places after the period, followed by a space, followed by MB, GB, or TB (for example, 1.25 TB). The minimum value is 1 (one) for GB and .01 for TB. The maximum value is equal to the hard quota for the tenant. The default is 50 GB.

hashScheme String

Specifies the default cryptographic hash algorithm for new HCP namespaces. Valid values are:

  • MD5
  • SHA-1
  • SHA-256
  • SHA-384
  • SHA-512
  • RIPEMD-160

These values are case sensitive.

The default is SHA-256.

multipartUploadAuto AbortDays Long

Specifies the default number of days multipart uploads can remain incomplete before they are automatically aborted. Valid values are integers in the range zero through 180. The default is 30.

A value of zero means multipart uploads are never automatically aborted.

retentionType String Specifies the retention type to be applied to all objects in the namespace. Valid values are:
HCP
HCP retention type
S3
S3 Object Lock

Default value is HCP retention.

When you set the retentionType to S3 Object Lock in a MAPI request for a namespace, versioning, delete markers, and cloud-optimized protocols are automatically enabled. You do not need to set these parameters explicitly.
optimizedFor String

Specifies whether new namespaces are cloud optimized by default. Valid values are:

ALL
The namespace is optimized for all namespace access protocols.
CLOUD
The namespace is optimized for cloud protocols only.
DEFAULT
The protocol optimization setting for the namespace is determined by the system-level setting for this property.

The default is DEFAULT.

These values are not case sensitive.

You can set this property to ALL or DEFAULT on a POST request only if new namespaces already disallow erasure coding by default or the allowErasureCoding property is set to false in the same request.
replicationEnabled Boolean

Specifies the default replication setting for new HCP namespaces. Valid values are:

true
The namespace is selected for replication.
false
The namespace is not selected for replication.

The default is false.

This property is valid on a POST request and returned by a GET request only if replication is enabled for the tenant for which you’re specifying namespace defaults.
s3UnversionedOverwrite Boolean

Specifies whether object overwrite is enabled for the namespace. Valid values are:

true
Object overwrite is enabled.
false
Object overwrite is disabled.

The default is false.

You can set the value of this property to either true or false. However, if you enable versioning for the namespace, changing the value will not have any effect. This property applies only to the requests made through Hitachi API for Amazon S3.

Overwriting an object will also overwrite its custom metadata.

searchEnabled Boolean

Specifies the default search setting for new HCP namespaces. Valid values are:

true
Search is enabled.
false
Search is disabled.

The default is false.

This property is valid on a POST request and returned by a GET request only if the owning tenant is allowed to enable search for its namespaces.
servicePlan String Specifies the default service plan for new HCP namespaces. Valid values are names of existing service plans. The default is the Default service plan. This property is valid on a POST request and returned by a GET request only if the tenant for which you’re specifying namespace defaults is allowed to select service plans for its namespaces.
softQuota Integer Specifies the default soft quota for new HCP namespaces. Valid values are integers in the range ten through 95. The default is 85.
versioningSettings

versioning

Settings

Specifies the default versioning settings for new HCP namespaces.

The default is no versioning.

This property is valid on a POST request and returned by a GET request only if the tenant for which you’re specifying namespace defaults has versioning configuration enabled.

Example

Here’s an XML example of the namespaceDefaults data type:

<namespaceDefaults>
    <description></description>
    <dpl>Dynamic</dpl>
    <effectiveDpl>Dynamic</effectiveDpl>
    <enterpriseMode>true</enterpriseMode>
    <allowErasureCoding>true</allowErasureCoding>
    <hardQuota>75 GB</hardQuota>
    <hashScheme>SHA-256</hashScheme>
    <optimizedFor>CLOUD</optimizedFor>
    <replicationEnabled>true</replicationEnabled>
    <searchEnabled>true</searchEnabled>
    <servicePlan>Short-Term-Activity</servicePlan>
    <softQuota>75</softQuota>
    <versioningSettings>
         <enabled>true</enabled>
         <prune>true</prune>
         <pruneDays>10</pruneDays>
         <useDeleteMarkers>true</useDeleteMarkers>
    </versioningSettings>
</namespaceDefaults>