software.amazon.awssdk.services.s3.model.LoggingEnabled Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of s3 Show documentation
Show all versions of s3 Show documentation
The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with
Amazon Simple Storage Service
/*
* 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.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more
* information, see PUT Bucket
* logging in the Amazon Simple Storage Service API Reference.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class LoggingEnabled implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TARGET_BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TargetBucket")
.getter(getter(LoggingEnabled::targetBucket))
.setter(setter(Builder::targetBucket))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetBucket")
.unmarshallLocationName("TargetBucket").build()).build();
private static final SdkField> TARGET_GRANTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TargetGrants")
.getter(getter(LoggingEnabled::targetGrants))
.setter(setter(Builder::targetGrants))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetGrants")
.unmarshallLocationName("TargetGrants").build(),
ListTrait
.builder()
.memberLocationName("Grant")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(TargetGrant::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Grant").unmarshallLocationName("Grant").build()).build())
.build()).build();
private static final SdkField TARGET_PREFIX_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TargetPrefix")
.getter(getter(LoggingEnabled::targetPrefix))
.setter(setter(Builder::targetPrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetPrefix")
.unmarshallLocationName("TargetPrefix").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TARGET_BUCKET_FIELD,
TARGET_GRANTS_FIELD, TARGET_PREFIX_FIELD));
private static final long serialVersionUID = 1L;
private final String targetBucket;
private final List targetGrants;
private final String targetPrefix;
private LoggingEnabled(BuilderImpl builder) {
this.targetBucket = builder.targetBucket;
this.targetGrants = builder.targetGrants;
this.targetPrefix = builder.targetPrefix;
}
/**
*
* Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to
* any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets
* to deliver their logs to the same target bucket. In this case, you should choose a different
* TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.
*
*
* @return Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs
* delivered to any bucket that you own, including the same bucket that is being logged. You can also
* configure multiple buckets to deliver their logs to the same target bucket. In this case, you should
* choose a different TargetPrefix for each source bucket so that the delivered log files can
* be distinguished by key.
*/
public String targetBucket() {
return targetBucket;
}
/**
* Returns true if the TargetGrants property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasTargetGrants() {
return targetGrants != null && !(targetGrants instanceof SdkAutoConstructList);
}
/**
*
* Container for granting information.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTargetGrants()} to see if a value was sent in this field.
*
*
* @return Container for granting information.
*/
public List targetGrants() {
return targetGrants;
}
/**
*
* A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you
* can use a prefix to distinguish which log files came from which bucket.
*
*
* @return A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single
* bucket, you can use a prefix to distinguish which log files came from which bucket.
*/
public String targetPrefix() {
return targetPrefix;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(targetBucket());
hashCode = 31 * hashCode + Objects.hashCode(hasTargetGrants() ? targetGrants() : null);
hashCode = 31 * hashCode + Objects.hashCode(targetPrefix());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof LoggingEnabled)) {
return false;
}
LoggingEnabled other = (LoggingEnabled) obj;
return Objects.equals(targetBucket(), other.targetBucket()) && hasTargetGrants() == other.hasTargetGrants()
&& Objects.equals(targetGrants(), other.targetGrants()) && Objects.equals(targetPrefix(), other.targetPrefix());
}
/**
* 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 String toString() {
return ToString.builder("LoggingEnabled").add("TargetBucket", targetBucket())
.add("TargetGrants", hasTargetGrants() ? targetGrants() : null).add("TargetPrefix", targetPrefix()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TargetBucket":
return Optional.ofNullable(clazz.cast(targetBucket()));
case "TargetGrants":
return Optional.ofNullable(clazz.cast(targetGrants()));
case "TargetPrefix":
return Optional.ofNullable(clazz.cast(targetPrefix()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((LoggingEnabled) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered
* to any bucket that you own, including the same bucket that is being logged. You can also configure multiple
* buckets to deliver their logs to the same target bucket. In this case, you should choose a different
* TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.
*
*
* @param targetBucket
* Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs
* delivered to any bucket that you own, including the same bucket that is being logged. You can also
* configure multiple buckets to deliver their logs to the same target bucket. In this case, you should
* choose a different TargetPrefix for each source bucket so that the delivered log files
* can be distinguished by key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetBucket(String targetBucket);
/**
*
* Container for granting information.
*
*
* @param targetGrants
* Container for granting information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetGrants(Collection targetGrants);
/**
*
* Container for granting information.
*
*
* @param targetGrants
* Container for granting information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetGrants(TargetGrant... targetGrants);
/**
*
* Container for granting information.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #targetGrants(List)}.
*
* @param targetGrants
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #targetGrants(List)
*/
Builder targetGrants(Consumer... targetGrants);
/**
*
* A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket,
* you can use a prefix to distinguish which log files came from which bucket.
*
*
* @param targetPrefix
* A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single
* bucket, you can use a prefix to distinguish which log files came from which bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetPrefix(String targetPrefix);
}
static final class BuilderImpl implements Builder {
private String targetBucket;
private List targetGrants = DefaultSdkAutoConstructList.getInstance();
private String targetPrefix;
private BuilderImpl() {
}
private BuilderImpl(LoggingEnabled model) {
targetBucket(model.targetBucket);
targetGrants(model.targetGrants);
targetPrefix(model.targetPrefix);
}
public final String getTargetBucket() {
return targetBucket;
}
@Override
public final Builder targetBucket(String targetBucket) {
this.targetBucket = targetBucket;
return this;
}
public final void setTargetBucket(String targetBucket) {
this.targetBucket = targetBucket;
}
public final Collection getTargetGrants() {
if (targetGrants instanceof SdkAutoConstructList) {
return null;
}
return targetGrants != null ? targetGrants.stream().map(TargetGrant::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder targetGrants(Collection targetGrants) {
this.targetGrants = TargetGrantsCopier.copy(targetGrants);
return this;
}
@Override
@SafeVarargs
public final Builder targetGrants(TargetGrant... targetGrants) {
targetGrants(Arrays.asList(targetGrants));
return this;
}
@Override
@SafeVarargs
public final Builder targetGrants(Consumer... targetGrants) {
targetGrants(Stream.of(targetGrants).map(c -> TargetGrant.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setTargetGrants(Collection targetGrants) {
this.targetGrants = TargetGrantsCopier.copyFromBuilder(targetGrants);
}
public final String getTargetPrefix() {
return targetPrefix;
}
@Override
public final Builder targetPrefix(String targetPrefix) {
this.targetPrefix = targetPrefix;
return this;
}
public final void setTargetPrefix(String targetPrefix) {
this.targetPrefix = targetPrefix;
}
@Override
public LoggingEnabled build() {
return new LoggingEnabled(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy