com.oracle.bmc.objectstorage.model

Class CreateBucketDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.objectstorage.model.CreateBucketDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CreateBucketDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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 CreateBucketDetails.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 CreateBucketDetails.Builder, which maintain a set of all explicitly set fields called CreateBucketDetails.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateBucketDetails.Builder
static class	CreateBucketDetails.PublicAccessType The type of public access enabled on this bucket.
static class	CreateBucketDetails.StorageTier The type of storage tier of this bucket.
static class	CreateBucketDetails.Versioning Set the versioning status on the bucket.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
CreateBucketDetails(String name, String compartmentId, Map<String,String> metadata, CreateBucketDetails.PublicAccessType publicAccessType, CreateBucketDetails.StorageTier storageTier, Boolean objectEventsEnabled, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String kmsKeyId, CreateBucketDetails.Versioning versioning, Bucket.AutoTiering autoTiering) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateBucketDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
Bucket.AutoTiering	getAutoTiering() Set the auto tiering status on the bucket.
String	getCompartmentId() The ID of the compartment in which to create the bucket.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
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.
Map<String,String>	getMetadata() Arbitrary string, up to 4KB, of keys and values for user-defined metadata.
String	getName() The name of the bucket.
Boolean	getObjectEventsEnabled() Whether or not events are emitted for object state changes in this bucket.
CreateBucketDetails.PublicAccessType	getPublicAccessType() The type of public access enabled on this bucket.
CreateBucketDetails.StorageTier	getStorageTier() The type of storage tier of this bucket.
CreateBucketDetails.Versioning	getVersioning() Set the versioning status on the bucket.
int	hashCode()
CreateBucketDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateBucketDetails

@Deprecated
 @ConstructorProperties(value={"name","compartmentId","metadata","publicAccessType","storageTier","objectEventsEnabled","freeformTags","definedTags","kmsKeyId","versioning","autoTiering"})
public CreateBucketDetails(String name,
                                                                                                                                                                                                                                    String compartmentId,
                                                                                                                                                                                                                                    Map<String,String> metadata,
                                                                                                                                                                                                                                    CreateBucketDetails.PublicAccessType publicAccessType,
                                                                                                                                                                                                                                    CreateBucketDetails.StorageTier storageTier,
                                                                                                                                                                                                                                    Boolean objectEventsEnabled,
                                                                                                                                                                                                                                    Map<String,String> freeformTags,
                                                                                                                                                                                                                                    Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                    String kmsKeyId,
                                                                                                                                                                                                                                    CreateBucketDetails.Versioning versioning,
                                                                                                                                                                                                                                    Bucket.AutoTiering autoTiering)

Deprecated.

Method Detail

builder

public static CreateBucketDetails.Builder builder()

Create a new builder.

toBuilder

public CreateBucketDetails.Builder toBuilder()

getName

public String getName()

The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. example: Example: my-new-bucket1

Returns:

the value

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to create the bucket.

Returns:

the value

getMetadata

public Map<String,String> getMetadata()

Arbitrary string, up to 4KB, of keys and values for user-defined metadata.

Returns:

the value

getPublicAccessType

public CreateBucketDetails.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 CreateBucketDetails.StorageTier getStorageTier()

The type of storage tier of this bucket. A bucket is set to ‘Standard’ tier by default, which means the bucket will be put in the standard storage tier. When ‘Archive’ tier type is set explicitly, the bucket is put in the Archive Storage tier. 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

getVersioning

public CreateBucketDetails.Versioning getVersioning()

Set the versioning status on the bucket. By default, a bucket is created with versioning Disabled. Use this option to enable versioning during bucket creation. Objects in a version enabled bucket are protected from overwrites and deletions. Previous versions of the same object will be available in the bucket.

Returns:

the value

getAutoTiering

public Bucket.AutoTiering getAutoTiering()

Set the auto tiering status on the bucket. By default, a bucket is created with auto tiering Disabled. Use this option to enable auto tiering during bucket creation. Objects in a bucket with auto tiering set to InfrequentAccess 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