CreateBucketRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.CreateBucketRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateBucketRequest
extends S3Request
implements ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateBucketRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateBucketRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BucketCannedACL`	`acl()` The canned ACL to apply to the bucket.
`String`	`aclAsString()` The canned ACL to apply to the bucket.
`String`	`bucket()` Returns the value of the Bucket property for this object.
`static CreateBucketRequest.Builder`	`builder()`
`CreateBucketConfiguration`	`createBucketConfiguration()` Returns the value of the CreateBucketConfiguration property for this object.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`String`	`grantFullControl()` Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
`String`	`grantRead()` Allows grantee to list the objects in the bucket.
`String`	`grantReadACP()` Allows grantee to read the bucket ACL.
`String`	`grantWrite()` Allows grantee to create, overwrite, and delete any object in the bucket.
`String`	`grantWriteACP()` Allows grantee to write the ACL for the applicable bucket.
`int`	`hashCode()`
`Boolean`	`objectLockEnabledForBucket()` Specifies whether you want S3 Object Lock to be enabled for the new bucket.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateBucketRequest.Builder>`	`serializableBuilderClass()`
`CreateBucketRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - acl
```
public BucketCannedACL acl()
```
    The canned ACL to apply to the bucket.
    
    If the service returns an enum value that is not available in the current SDK version, acl will return BucketCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().
    
    Returns:
    
    The canned ACL to apply to the bucket.
    
    See Also:
    
    BucketCannedACL
  - aclAsString
```
public String aclAsString()
```
    The canned ACL to apply to the bucket.
    
    If the service returns an enum value that is not available in the current SDK version, acl will return BucketCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().
    
    Returns:
    
    The canned ACL to apply to the bucket.
    
    See Also:
    
    BucketCannedACL
  - bucket
```
public String bucket()
```
    Returns the value of the Bucket property for this object.
    
    Returns:
    
    The value of the Bucket property for this object.
  - createBucketConfiguration
```
public CreateBucketConfiguration createBucketConfiguration()
```
    Returns the value of the CreateBucketConfiguration property for this object.
    
    Returns:
    
    The value of the CreateBucketConfiguration property for this object.
  - grantFullControl
```
public String grantFullControl()
```
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
    
    Returns:
    
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
  - grantRead
```
public String grantRead()
```
    Allows grantee to list the objects in the bucket.
    
    Returns:
    
    Allows grantee to list the objects in the bucket.
  - grantReadACP
```
public String grantReadACP()
```
    Allows grantee to read the bucket ACL.
    
    Returns:
    
    Allows grantee to read the bucket ACL.
  - grantWrite
```
public String grantWrite()
```
    Allows grantee to create, overwrite, and delete any object in the bucket.
    
    Returns:
    
    Allows grantee to create, overwrite, and delete any object in the bucket.
  - grantWriteACP
```
public String grantWriteACP()
```
    Allows grantee to write the ACL for the applicable bucket.
    
    Returns:
    
    Allows grantee to write the ACL for the applicable bucket.
  - objectLockEnabledForBucket
```
public Boolean objectLockEnabledForBucket()
```
    Specifies whether you want S3 Object Lock to be enabled for the new bucket.
    
    Returns:
    
    Specifies whether you want S3 Object Lock to be enabled for the new bucket.
  - toBuilder
```
public CreateBucketRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateBucketRequest.Builder,CreateBucketRequest>
    
    Specified by:
    
    toBuilder in class S3Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateBucketRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateBucketRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class CreateBucketRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

acl

aclAsString

bucket

createBucketConfiguration

grantFullControl

grantRead

grantReadACP

grantWrite

grantWriteACP

objectLockEnabledForBucket

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields