com.ibm.cos.v2.services.s3.model

Class PutBucketRequestPaymentRequest

java.lang.Object

com.ibm.cos.v2.core.SdkRequest

com.ibm.cos.v2.awscore.AwsRequest

com.ibm.cos.v2.services.s3.model.S3Request

com.ibm.cos.v2.services.s3.model.PutBucketRequestPaymentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutBucketRequestPaymentRequest.Builder,PutBucketRequestPaymentRequest>

@Generated(value="com.ibm.cos.v2:codegen")
public final class PutBucketRequestPaymentRequest
extends S3Request
implements ToCopyableBuilder<PutBucketRequestPaymentRequest.Builder,PutBucketRequestPaymentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutBucketRequestPaymentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The bucket name.
static PutBucketRequestPaymentRequest.Builder	builder()
ChecksumAlgorithm	checksumAlgorithm() Indicates the algorithm used to create the checksum for the request when you use the SDK.
String	checksumAlgorithmAsString() Indicates the algorithm used to create the checksum for the request when you use the SDK.
String	contentMD5() The Base64 encoded 128-bit MD5 digest of the data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	expectedBucketOwner() The account ID of the expected bucket owner.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RequestPaymentConfiguration	requestPaymentConfiguration() Container for Payer.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutBucketRequestPaymentRequest.Builder>	serializableBuilderClass()
PutBucketRequestPaymentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

bucket

public final String bucket()

The bucket name.

Returns:

The bucket name.

contentMD5

public final String contentMD5()

The Base64 encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

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

Returns:

The Base64 encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

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

checksumAlgorithm

public final ChecksumAlgorithm checksumAlgorithm()

Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

Returns:

Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

See Also:

ChecksumAlgorithm

checksumAlgorithmAsString

public final String checksumAlgorithmAsString()

Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

Returns:

Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

See Also:

ChecksumAlgorithm

requestPaymentConfiguration

public final RequestPaymentConfiguration requestPaymentConfiguration()

Container for Payer.

Returns:

Container for Payer.

expectedBucketOwner

public final String expectedBucketOwner()

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

toBuilder

public PutBucketRequestPaymentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutBucketRequestPaymentRequest.Builder,PutBucketRequestPaymentRequest>

Specified by:

toBuilder in class S3Request

builder

public static PutBucketRequestPaymentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutBucketRequestPaymentRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo