@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class Bucket extends Object
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.
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 __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Bucket.Builder |
static class |
Bucket.PublicAccessType
The type of public access enabled on this bucket.
|
static class |
Bucket.StorageTier
The storage tier type assigned to the bucket.
|
| Constructor and Description |
|---|
Bucket(String namespace,
String name,
String compartmentId,
Map<String,String> metadata,
String createdBy,
Date timeCreated,
String etag,
Bucket.PublicAccessType publicAccessType,
Bucket.StorageTier storageTier,
Boolean objectEventsEnabled,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
String kmsKeyId,
String objectLifecyclePolicyEtag,
Long approximateCount,
Long approximateSize)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Bucket.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
Long |
getApproximateCount()
The approximate number of objects in the bucket.
|
Long |
getApproximateSize()
The approximate total size in bytes of all objects in the bucket.
|
String |
getCompartmentId()
The compartment ID in which the bucket is authorized.
|
String |
getCreatedBy()
The OCID of the user who created the bucket.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getEtag()
The entity tag (ETag) for the bucket.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getKmsKeyId()
The OCID of a KMS key id used to call KMS to generate data key or decrypt the encrypted data key.
|
Map<String,String> |
getMetadata()
Arbitrary string keys and values for user-defined metadata.
|
String |
getName()
The name of the bucket.
|
String |
getNamespace()
The Object Storage namespace in which the bucket lives.
|
Boolean |
getObjectEventsEnabled()
A property that determines whether events will be generated for operations on objects in this bucket.
|
String |
getObjectLifecyclePolicyEtag()
The entity tag (ETag) for the live object lifecycle policy on the bucket.
|
Bucket.PublicAccessType |
getPublicAccessType()
The type of public access enabled on this bucket.
|
Bucket.StorageTier |
getStorageTier()
The storage tier type assigned to the bucket.
|
Date |
getTimeCreated()
The date and time the bucket was created, as described in RFC 2616, section 14.29.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"namespace","name","compartmentId","metadata","createdBy","timeCreated","etag","publicAccessType","storageTier","objectEventsEnabled","freeformTags","definedTags","kmsKeyId","objectLifecyclePolicyEtag","approximateCount","approximateSize"}) @Deprecated public Bucket(String namespace, String name, String compartmentId, Map<String,String> metadata, String createdBy, Date timeCreated, String etag, Bucket.PublicAccessType publicAccessType, Bucket.StorageTier storageTier, Boolean objectEventsEnabled, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String kmsKeyId, String objectLifecyclePolicyEtag, Long approximateCount, Long approximateSize)
public static Bucket.Builder builder()
Create a new builder.
public String getNamespace()
The Object Storage namespace in which the bucket lives.
public String getName()
The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
public String getCompartmentId()
The compartment ID in which the bucket is authorized.
public Map<String,String> getMetadata()
Arbitrary string keys and values for user-defined metadata.
public String getCreatedBy()
The OCID of the user who created the bucket.
public Date getTimeCreated()
The date and time the bucket was created, as described in RFC 2616, section 14.29.
public String getEtag()
The entity tag (ETag) for the bucket.
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.
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.
public Boolean getObjectEventsEnabled()
A property that determines whether events will be generated for operations on objects in this bucket. This is false by default.
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\"}
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\"}}
public String getKmsKeyId()
The OCID of a KMS key id used to call KMS to generate data key or decrypt the encrypted data key.
public String getObjectLifecyclePolicyEtag()
The entity tag (ETag) for the live object lifecycle policy on the bucket.
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.
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.
Copyright © 2016–2019. All rights reserved.