software.amazon.awssdk.services.s3.model.PutBucketLoggingRequest Maven / Gradle / Ivy
Show all versions of s3 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.s3.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.PayloadTrait;
import software.amazon.awssdk.core.traits.RequiredTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutBucketLoggingRequest extends S3Request implements
ToCopyableBuilder {
private static final SdkField BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Bucket")
.getter(getter(PutBucketLoggingRequest::bucket))
.setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build(), RequiredTrait.create()).build();
private static final SdkField BUCKET_LOGGING_STATUS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("BucketLoggingStatus")
.getter(getter(PutBucketLoggingRequest::bucketLoggingStatus))
.setter(setter(Builder::bucketLoggingStatus))
.constructor(BucketLoggingStatus::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BucketLoggingStatus")
.unmarshallLocationName("BucketLoggingStatus").build(), PayloadTrait.create(), RequiredTrait.create())
.build();
private static final SdkField CONTENT_MD5_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentMD5")
.getter(getter(PutBucketLoggingRequest::contentMD5))
.setter(setter(Builder::contentMD5))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-MD5")
.unmarshallLocationName("Content-MD5").build()).build();
private static final SdkField CHECKSUM_ALGORITHM_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumAlgorithm")
.getter(getter(PutBucketLoggingRequest::checksumAlgorithmAsString))
.setter(setter(Builder::checksumAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-sdk-checksum-algorithm")
.unmarshallLocationName("x-amz-sdk-checksum-algorithm").build()).build();
private static final SdkField EXPECTED_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedBucketOwner")
.getter(getter(PutBucketLoggingRequest::expectedBucketOwner))
.setter(setter(Builder::expectedBucketOwner))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-expected-bucket-owner")
.unmarshallLocationName("x-amz-expected-bucket-owner").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BUCKET_FIELD,
BUCKET_LOGGING_STATUS_FIELD, CONTENT_MD5_FIELD, CHECKSUM_ALGORITHM_FIELD, EXPECTED_BUCKET_OWNER_FIELD));
private final String bucket;
private final BucketLoggingStatus bucketLoggingStatus;
private final String contentMD5;
private final String checksumAlgorithm;
private final String expectedBucketOwner;
private PutBucketLoggingRequest(BuilderImpl builder) {
super(builder);
this.bucket = builder.bucket;
this.bucketLoggingStatus = builder.bucketLoggingStatus;
this.contentMD5 = builder.contentMD5;
this.checksumAlgorithm = builder.checksumAlgorithm;
this.expectedBucketOwner = builder.expectedBucketOwner;
}
/**
*
* The name of the bucket for which to set the logging parameters.
*
*
* @return The name of the bucket for which to set the logging parameters.
*/
public final String bucket() {
return bucket;
}
/**
*
* Container for logging status information.
*
*
* @return Container for logging status information.
*/
public final BucketLoggingStatus bucketLoggingStatus() {
return bucketLoggingStatus;
}
/**
*
* The MD5 hash of the PutBucketLogging
request body.
*
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this
* field is calculated automatically.
*
*
* @return The MD5 hash of the PutBucketLogging
request body.
*
* For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs,
* this field is calculated automatically.
*/
public final String contentMD5() {
return contentMD5;
}
/**
*
* Indicates the algorithm used to create the checksum for the object 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, {@link #checksumAlgorithm}
* will return {@link ChecksumAlgorithm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #checksumAlgorithmAsString}.
*
*
* @return Indicates the algorithm used to create the checksum for the object 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 ChecksumAlgorithm
*/
public final ChecksumAlgorithm checksumAlgorithm() {
return ChecksumAlgorithm.fromValue(checksumAlgorithm);
}
/**
*
* Indicates the algorithm used to create the checksum for the object 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, {@link #checksumAlgorithm}
* will return {@link ChecksumAlgorithm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #checksumAlgorithmAsString}.
*
*
* @return Indicates the algorithm used to create the checksum for the object 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 ChecksumAlgorithm
*/
public final String checksumAlgorithmAsString() {
return checksumAlgorithm;
}
/**
*
* 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).
*
*
* @return 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).
*/
public final String expectedBucketOwner() {
return expectedBucketOwner;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(bucket());
hashCode = 31 * hashCode + Objects.hashCode(bucketLoggingStatus());
hashCode = 31 * hashCode + Objects.hashCode(contentMD5());
hashCode = 31 * hashCode + Objects.hashCode(checksumAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(expectedBucketOwner());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutBucketLoggingRequest)) {
return false;
}
PutBucketLoggingRequest other = (PutBucketLoggingRequest) obj;
return Objects.equals(bucket(), other.bucket()) && Objects.equals(bucketLoggingStatus(), other.bucketLoggingStatus())
&& Objects.equals(contentMD5(), other.contentMD5())
&& Objects.equals(checksumAlgorithmAsString(), other.checksumAlgorithmAsString())
&& Objects.equals(expectedBucketOwner(), other.expectedBucketOwner());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("PutBucketLoggingRequest").add("Bucket", bucket())
.add("BucketLoggingStatus", bucketLoggingStatus()).add("ContentMD5", contentMD5())
.add("ChecksumAlgorithm", checksumAlgorithmAsString()).add("ExpectedBucketOwner", expectedBucketOwner()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Bucket":
return Optional.ofNullable(clazz.cast(bucket()));
case "BucketLoggingStatus":
return Optional.ofNullable(clazz.cast(bucketLoggingStatus()));
case "ContentMD5":
return Optional.ofNullable(clazz.cast(contentMD5()));
case "ChecksumAlgorithm":
return Optional.ofNullable(clazz.cast(checksumAlgorithmAsString()));
case "ExpectedBucketOwner":
return Optional.ofNullable(clazz.cast(expectedBucketOwner()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function