Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Bucket

A bucket is a container for storing objects in a compartment within a namespace. A bucket is associated with a single compartment. The compartment has policies that indicate what actions a user can perform on a bucket and all the objects in the bucket. For more information, see Managing Buckets.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

Properties

Optional approximateCount

approximateCount: undefined | number

The approximate number of objects in the bucket. Count statistics are reported periodically. You will see a lag between what is displayed and the actual object count. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional approximateSize

approximateSize: undefined | number

The approximate total size in bytes of all objects in the bucket. Size statistics are reported periodically. You will see a lag between what is displayed and the actual size of the bucket. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional autoTiering

autoTiering: AutoTiering

The auto tiering status on the bucket. A bucket is created with auto tiering {@code Disabled} by default. For auto tiering {@code InfrequentAccess}, objects are transitioned automatically between the 'Standard' and 'InfrequentAccess' tiers based on the access pattern of the objects.

compartmentId

compartmentId: string

The compartment ID in which the bucket is authorized.

createdBy

createdBy: string

The OCID of the user who created the bucket.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

etag

etag: string

The entity tag (ETag) for the bucket.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

Optional id

id: undefined | string

The OCID of the bucket.

Optional isReadOnly

isReadOnly: undefined | false | true

Whether or not this bucket is read only. By default, {@code isReadOnly} is set to {@code false}. This will be set to 'true' when this bucket is configured as a destination in a replication policy.

Optional kmsKeyId

kmsKeyId: undefined | string

The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

metadata

metadata: object

Arbitrary string keys and values for user-defined metadata.

Type declaration

  • [key: string]: string

name

name: string

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

namespace

namespace: string

The Object Storage namespace in which the bucket resides.

Optional objectEventsEnabled

objectEventsEnabled: undefined | false | true

Whether or not events are emitted for object state changes in this bucket. By default, {@code objectEventsEnabled} is set to {@code false}. Set {@code objectEventsEnabled} to {@code true} to emit events for object state changes. For more information about events, see Overview of Events.

Optional objectLifecyclePolicyEtag

objectLifecyclePolicyEtag: undefined | string

The entity tag (ETag) for the live object lifecycle policy on the bucket.

Optional publicAccessType

publicAccessType: PublicAccessType

The type of public access enabled on this bucket. A bucket is set to {@code NoPublicAccess} by default, which only allows an authenticated caller to access the bucket and its contents. When {@code ObjectRead} is enabled on the bucket, public access is allowed for the {@code GetObject}, {@code HeadObject}, and {@code ListObjects} operations. When {@code ObjectReadWithoutList} is enabled on the bucket, public access is allowed for the {@code GetObject} and {@code HeadObject} operations.

Optional replicationEnabled

replicationEnabled: undefined | false | true

Whether or not this bucket is a replication source. By default, {@code replicationEnabled} is set to {@code false}. This will be set to 'true' when you create a replication policy for the bucket.

Optional storageTier

storageTier: StorageTier

The storage tier type assigned to the bucket. A bucket is set to {@code Standard} tier by default, which means objects uploaded or copied to the bucket will be in the standard storage tier. When the {@code Archive} tier type is set explicitly for a bucket, objects uploaded or copied to the bucket will be stored in archive storage. The {@code storageTier} property is immutable after bucket is created.

timeCreated

timeCreated: Date

The date and time the bucket was created, as described in RFC 2616.

Optional versioning

versioning: Versioning

The versioning status on the bucket. A bucket is created with versioning {@code Disabled} by default. For versioning {@code Enabled}, objects are protected from overwrites and deletes, by maintaining their version history. When versioning is {@code Suspended}, the previous versions will still remain but new versions will no longer be created when overwitten or deleted.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Bucket): object

getJsonObj

  • getJsonObj(obj: Bucket): object