Package com.oracle.bmc.objectstorage.model

Class Bucket

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Bucket
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
    Note: Objects should always be created or deserialized using the Bucket.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Bucket.Builder, which maintain a set of all explicitly set fields called Bucket.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Bucket.Builder builder()
        Create a new builder.

      • getNamespace

        public String getNamespace()
        The Object Storage namespace in which the bucket resides.
        Returns:
        the value

      • getName

        public String getName()
        The name of the bucket.

        Avoid entering confidential information. Example: my-new-bucket1

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The compartment ID in which the bucket is authorized.
        Returns:
        the value

      • getMetadata

        public Map<String,​String> getMetadata()
        Arbitrary string keys and values for user-defined metadata.
        Returns:
        the value

      • getCreatedBy

        public String getCreatedBy()
        The OCID of the user who created the bucket.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the bucket was created, as described in RFC 2616.
        Returns:
        the value

      • getEtag

        public String getEtag()
        The entity tag (ETag) for the bucket.
        Returns:
        the value

      • getPublicAccessType

        public Bucket.PublicAccessType getPublicAccessType()
        The type of public access enabled on this bucket.

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

        Returns:
        the value

      • getStorageTier

        public Bucket.StorageTier getStorageTier()
        The storage tier type assigned to the bucket.

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

        Returns:
        the value

      • getObjectEventsEnabled

        public Boolean getObjectEventsEnabled()
        Whether or not events are emitted for object state changes in this bucket.

        By default, objectEventsEnabled is set to false. Set objectEventsEnabled to true to emit events for object state changes. For more information about events, see Overview of Events.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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: {“Department”: “Finance”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value

      • getKmsKeyId

        public String getKmsKeyId()
        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.
        Returns:
        the value

      • getObjectLifecyclePolicyEtag

        public String getObjectLifecyclePolicyEtag()
        The entity tag (ETag) for the live object lifecycle policy on the bucket.
        Returns:
        the value

      • getApproximateCount

        public Long getApproximateCount()
        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.

        Returns:
        the value

      • getApproximateSize

        public Long getApproximateSize()
        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.

        Returns:
        the value

      • getReplicationEnabled

        public Boolean getReplicationEnabled()
        Whether or not this bucket is a replication source.

        By default, replicationEnabled is set to false. This will be set to ‘true’ when you create a replication policy for the bucket.

        Returns:
        the value

      • getIsReadOnly

        public Boolean getIsReadOnly()
        Whether or not this bucket is read only.

        By default, isReadOnly is set to false. This will be set to ‘true’ when this bucket is configured as a destination in a replication policy.

        Returns:
        the value

      • getId

        public String getId()
        The OCID of the bucket.
        Returns:
        the value

      • getVersioning

        public Bucket.Versioning getVersioning()
        The versioning status on the bucket.

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

        Returns:
        the value

      • getAutoTiering

        public Bucket.AutoTiering getAutoTiering()
        The auto tiering status on the bucket.

        A bucket is created with auto tiering Disabled by default. For auto tiering InfrequentAccess, objects are transitioned automatically between the ‘Standard’ and ‘InfrequentAccess’ tiers based on the access pattern of the objects.

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel