software.amazon.awssdk.services.s3.model.LifecycleRuleFilter 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 2014-2019 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.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.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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix,
* Tag, or And specified.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class LifecycleRuleFilter implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField PREFIX_FIELD = SdkField
. builder(MarshallingType.STRING)
.getter(getter(LifecycleRuleFilter::prefix))
.setter(setter(Builder::prefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Prefix")
.unmarshallLocationName("Prefix").build()).build();
private static final SdkField TAG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(LifecycleRuleFilter::tag))
.setter(setter(Builder::tag))
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tag").unmarshallLocationName("Tag")
.build()).build();
private static final SdkField AND_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.getter(getter(LifecycleRuleFilter::and))
.setter(setter(Builder::and))
.constructor(LifecycleRuleAndOperator::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("And").unmarshallLocationName("And")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PREFIX_FIELD, TAG_FIELD,
AND_FIELD));
private static final long serialVersionUID = 1L;
private final String prefix;
private final Tag tag;
private final LifecycleRuleAndOperator and;
private LifecycleRuleFilter(BuilderImpl builder) {
this.prefix = builder.prefix;
this.tag = builder.tag;
this.and = builder.and;
}
/**
*
* Prefix identifying one or more objects to which the rule applies.
*
*
* @return Prefix identifying one or more objects to which the rule applies.
*/
public String prefix() {
return prefix;
}
/**
*
* This tag must exist in the object's tag set in order for the rule to apply.
*
*
* @return This tag must exist in the object's tag set in order for the rule to apply.
*/
public Tag tag() {
return tag;
}
/**
*
*
* @return
*/
public LifecycleRuleAndOperator and() {
return and;
}
@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(prefix());
hashCode = 31 * hashCode + Objects.hashCode(tag());
hashCode = 31 * hashCode + Objects.hashCode(and());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof LifecycleRuleFilter)) {
return false;
}
LifecycleRuleFilter other = (LifecycleRuleFilter) obj;
return Objects.equals(prefix(), other.prefix()) && Objects.equals(tag(), other.tag())
&& Objects.equals(and(), other.and());
}
/**
* 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("LifecycleRuleFilter").add("Prefix", prefix()).add("Tag", tag()).add("And", and()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Prefix":
return Optional.ofNullable(clazz.cast(prefix()));
case "Tag":
return Optional.ofNullable(clazz.cast(tag()));
case "And":
return Optional.ofNullable(clazz.cast(and()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((LifecycleRuleFilter) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Prefix identifying one or more objects to which the rule applies.
*
*
* @param prefix
* Prefix identifying one or more objects to which the rule applies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder prefix(String prefix);
/**
*
* This tag must exist in the object's tag set in order for the rule to apply.
*
*
* @param tag
* This tag must exist in the object's tag set in order for the rule to apply.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tag(Tag tag);
/**
*
* This tag must exist in the object's tag set in order for the rule to apply.
*
* This is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one
* manually via {@link Tag#builder()}.
*
* When the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is
* passed to {@link #tag(Tag)}.
*
* @param tag
* a consumer that will call methods on {@link Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tag(Tag)
*/
default Builder tag(Consumer tag) {
return tag(Tag.builder().applyMutation(tag).build());
}
/**
*
*
* @param and
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder and(LifecycleRuleAndOperator and);
/**
*
* This is a convenience that creates an instance of the {@link LifecycleRuleAndOperator.Builder} avoiding the
* need to create one manually via {@link LifecycleRuleAndOperator#builder()}.
*
* When the {@link Consumer} completes, {@link LifecycleRuleAndOperator.Builder#build()} is called immediately
* and its result is passed to {@link #and(LifecycleRuleAndOperator)}.
*
* @param and
* a consumer that will call methods on {@link LifecycleRuleAndOperator.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #and(LifecycleRuleAndOperator)
*/
default Builder and(Consumer and) {
return and(LifecycleRuleAndOperator.builder().applyMutation(and).build());
}
}
static final class BuilderImpl implements Builder {
private String prefix;
private Tag tag;
private LifecycleRuleAndOperator and;
private BuilderImpl() {
}
private BuilderImpl(LifecycleRuleFilter model) {
prefix(model.prefix);
tag(model.tag);
and(model.and);
}
public final String getPrefix() {
return prefix;
}
@Override
public final Builder prefix(String prefix) {
this.prefix = prefix;
return this;
}
public final void setPrefix(String prefix) {
this.prefix = prefix;
}
public final Tag.Builder getTag() {
return tag != null ? tag.toBuilder() : null;
}
@Override
public final Builder tag(Tag tag) {
this.tag = tag;
return this;
}
public final void setTag(Tag.BuilderImpl tag) {
this.tag = tag != null ? tag.build() : null;
}
public final LifecycleRuleAndOperator.Builder getAnd() {
return and != null ? and.toBuilder() : null;
}
@Override
public final Builder and(LifecycleRuleAndOperator and) {
this.and = and;
return this;
}
public final void setAnd(LifecycleRuleAndOperator.BuilderImpl and) {
this.and = and != null ? and.build() : null;
}
@Override
public LifecycleRuleFilter build() {
return new LifecycleRuleFilter(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}