software.amazon.awssdk.services.s3.model

Class PutBucketPolicyRequest

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.PutBucketPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutBucketPolicyRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The name of the bucket.
static PutBucketPolicyRequest.Builder	builder()
Boolean	confirmRemoveSelfBucketAccess() Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
String	contentMD5() The MD5 hash of the request body.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	expectedBucketOwner() The account ID of the expected bucket owner.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	policy() The bucket policy as a JSON document.
List<SdkField<?>>	sdkFields()
static Class<? extends PutBucketPolicyRequest.Builder>	serializableBuilderClass()
PutBucketPolicyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

bucket

public final String bucket()

The name of the bucket.

Returns:

The name of the bucket.

contentMD5

public final String contentMD5()

The MD5 hash of the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Returns:

The MD5 hash of the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

confirmRemoveSelfBucketAccess

public final Boolean confirmRemoveSelfBucketAccess()

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

Returns:

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

policy

public final String policy()

The bucket policy as a JSON document.

Returns:

The bucket policy as a JSON document.

expectedBucketOwner

public final String expectedBucketOwner()

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

toBuilder

public PutBucketPolicyRequest.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<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static PutBucketPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutBucketPolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <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 final 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.