software.amazon.awssdk.services.s3.model.PutBucketMetricsConfigurationRequest Maven / Gradle / Ivy
/*
* 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.beans.Transient;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class PutBucketMetricsConfigurationRequest extends S3Request implements
ToCopyableBuilder {
private static final SdkField BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Bucket")
.getter(getter(PutBucketMetricsConfigurationRequest::bucket))
.setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build()).build();
private static final SdkField ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Id")
.getter(getter(PutBucketMetricsConfigurationRequest::id))
.setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("id")
.unmarshallLocationName("id").build()).build();
private static final SdkField METRICS_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("MetricsConfiguration")
.getter(getter(PutBucketMetricsConfigurationRequest::metricsConfiguration))
.setter(setter(Builder::metricsConfiguration))
.constructor(MetricsConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricsConfiguration")
.unmarshallLocationName("MetricsConfiguration").build(), PayloadTrait.create()).build();
private static final SdkField EXPECTED_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedBucketOwner")
.getter(getter(PutBucketMetricsConfigurationRequest::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, ID_FIELD,
METRICS_CONFIGURATION_FIELD, EXPECTED_BUCKET_OWNER_FIELD));
private final String bucket;
private final String id;
private final MetricsConfiguration metricsConfiguration;
private final String expectedBucketOwner;
private PutBucketMetricsConfigurationRequest(BuilderImpl builder) {
super(builder);
this.bucket = builder.bucket;
this.id = builder.id;
this.metricsConfiguration = builder.metricsConfiguration;
this.expectedBucketOwner = builder.expectedBucketOwner;
}
/**
*
* The name of the bucket for which the metrics configuration is set.
*
*
* @return The name of the bucket for which the metrics configuration is set.
*/
public final String bucket() {
return bucket;
}
/**
*
* The ID used to identify the metrics configuration.
*
*
* @return The ID used to identify the metrics configuration.
*/
public final String id() {
return id;
}
/**
*
* Specifies the metrics configuration.
*
*
* @return Specifies the metrics configuration.
*/
public final MetricsConfiguration metricsConfiguration() {
return metricsConfiguration;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String expectedBucketOwner() {
return expectedBucketOwner;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class 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(id());
hashCode = 31 * hashCode + Objects.hashCode(metricsConfiguration());
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 PutBucketMetricsConfigurationRequest)) {
return false;
}
PutBucketMetricsConfigurationRequest other = (PutBucketMetricsConfigurationRequest) obj;
return Objects.equals(bucket(), other.bucket()) && Objects.equals(id(), other.id())
&& Objects.equals(metricsConfiguration(), other.metricsConfiguration())
&& 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("PutBucketMetricsConfigurationRequest").add("Bucket", bucket()).add("Id", id())
.add("MetricsConfiguration", metricsConfiguration()).add("ExpectedBucketOwner", expectedBucketOwner()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Bucket":
return Optional.ofNullable(clazz.cast(bucket()));
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "MetricsConfiguration":
return Optional.ofNullable(clazz.cast(metricsConfiguration()));
case "ExpectedBucketOwner":
return Optional.ofNullable(clazz.cast(expectedBucketOwner()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutBucketMetricsConfigurationRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the bucket for which the metrics configuration is set.
*
*
* @param bucket
* The name of the bucket for which the metrics configuration is set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucket(String bucket);
/**
*
* The ID used to identify the metrics configuration.
*
*
* @param id
* The ID used to identify the metrics configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* Specifies the metrics configuration.
*
*
* @param metricsConfiguration
* Specifies the metrics configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricsConfiguration(MetricsConfiguration metricsConfiguration);
/**
*
* Specifies the metrics configuration.
*
* This is a convenience that creates an instance of the {@link MetricsConfiguration.Builder} avoiding the need
* to create one manually via {@link MetricsConfiguration#builder()}.
*
* When the {@link Consumer} completes, {@link MetricsConfiguration.Builder#build()} is called immediately and
* its result is passed to {@link #metricsConfiguration(MetricsConfiguration)}.
*
* @param metricsConfiguration
* a consumer that will call methods on {@link MetricsConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #metricsConfiguration(MetricsConfiguration)
*/
default Builder metricsConfiguration(Consumer metricsConfiguration) {
return metricsConfiguration(MetricsConfiguration.builder().applyMutation(metricsConfiguration).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expectedBucketOwner(String expectedBucketOwner);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends S3Request.BuilderImpl implements Builder {
private String bucket;
private String id;
private MetricsConfiguration metricsConfiguration;
private String expectedBucketOwner;
private BuilderImpl() {
}
private BuilderImpl(PutBucketMetricsConfigurationRequest model) {
super(model);
bucket(model.bucket);
id(model.id);
metricsConfiguration(model.metricsConfiguration);
expectedBucketOwner(model.expectedBucketOwner);
}
public final String getBucket() {
return bucket;
}
public final void setBucket(String bucket) {
this.bucket = bucket;
}
@Override
@Transient
public final Builder bucket(String bucket) {
this.bucket = bucket;
return this;
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
@Transient
public final Builder id(String id) {
this.id = id;
return this;
}
public final MetricsConfiguration.Builder getMetricsConfiguration() {
return metricsConfiguration != null ? metricsConfiguration.toBuilder() : null;
}
public final void setMetricsConfiguration(MetricsConfiguration.BuilderImpl metricsConfiguration) {
this.metricsConfiguration = metricsConfiguration != null ? metricsConfiguration.build() : null;
}
@Override
@Transient
public final Builder metricsConfiguration(MetricsConfiguration metricsConfiguration) {
this.metricsConfiguration = metricsConfiguration;
return this;
}
public final String getExpectedBucketOwner() {
return expectedBucketOwner;
}
public final void setExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
}
@Override
@Transient
public final Builder expectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutBucketMetricsConfigurationRequest build() {
return new PutBucketMetricsConfigurationRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy