software.amazon.awssdk.services.s3.model.ObjectLockRetention 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.io.Serializable;
import java.time.Instant;
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.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.core.traits.TimestampFormatTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A Retention configuration for an object.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ObjectLockRetention implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MODE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Mode")
.getter(getter(ObjectLockRetention::modeAsString))
.setter(setter(Builder::mode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Mode")
.unmarshallLocationName("Mode").build()).build();
private static final SdkField RETAIN_UNTIL_DATE_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("RetainUntilDate")
.getter(getter(ObjectLockRetention::retainUntilDate))
.setter(setter(Builder::retainUntilDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RetainUntilDate")
.unmarshallLocationName("RetainUntilDate").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MODE_FIELD,
RETAIN_UNTIL_DATE_FIELD));
private static final long serialVersionUID = 1L;
private final String mode;
private final Instant retainUntilDate;
private ObjectLockRetention(BuilderImpl builder) {
this.mode = builder.mode;
this.retainUntilDate = builder.retainUntilDate;
}
/**
*
* Indicates the Retention mode for the specified object.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link ObjectLockRetentionMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return Indicates the Retention mode for the specified object.
* @see ObjectLockRetentionMode
*/
public ObjectLockRetentionMode mode() {
return ObjectLockRetentionMode.fromValue(mode);
}
/**
*
* Indicates the Retention mode for the specified object.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link ObjectLockRetentionMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return Indicates the Retention mode for the specified object.
* @see ObjectLockRetentionMode
*/
public String modeAsString() {
return mode;
}
/**
*
* The date on which this Object Lock Retention will expire.
*
*
* @return The date on which this Object Lock Retention will expire.
*/
public Instant retainUntilDate() {
return retainUntilDate;
}
@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(modeAsString());
hashCode = 31 * hashCode + Objects.hashCode(retainUntilDate());
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 ObjectLockRetention)) {
return false;
}
ObjectLockRetention other = (ObjectLockRetention) obj;
return Objects.equals(modeAsString(), other.modeAsString()) && Objects.equals(retainUntilDate(), other.retainUntilDate());
}
/**
* 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("ObjectLockRetention").add("Mode", modeAsString()).add("RetainUntilDate", retainUntilDate())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Mode":
return Optional.ofNullable(clazz.cast(modeAsString()));
case "RetainUntilDate":
return Optional.ofNullable(clazz.cast(retainUntilDate()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ObjectLockRetention) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Indicates the Retention mode for the specified object.
*
*
* @param mode
* Indicates the Retention mode for the specified object.
* @see ObjectLockRetentionMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectLockRetentionMode
*/
Builder mode(String mode);
/**
*
* Indicates the Retention mode for the specified object.
*
*
* @param mode
* Indicates the Retention mode for the specified object.
* @see ObjectLockRetentionMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectLockRetentionMode
*/
Builder mode(ObjectLockRetentionMode mode);
/**
*
* The date on which this Object Lock Retention will expire.
*
*
* @param retainUntilDate
* The date on which this Object Lock Retention will expire.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder retainUntilDate(Instant retainUntilDate);
}
static final class BuilderImpl implements Builder {
private String mode;
private Instant retainUntilDate;
private BuilderImpl() {
}
private BuilderImpl(ObjectLockRetention model) {
mode(model.mode);
retainUntilDate(model.retainUntilDate);
}
public final String getMode() {
return mode;
}
@Override
public final Builder mode(String mode) {
this.mode = mode;
return this;
}
@Override
public final Builder mode(ObjectLockRetentionMode mode) {
this.mode(mode == null ? null : mode.toString());
return this;
}
public final void setMode(String mode) {
this.mode = mode;
}
public final Instant getRetainUntilDate() {
return retainUntilDate;
}
@Override
public final Builder retainUntilDate(Instant retainUntilDate) {
this.retainUntilDate = retainUntilDate;
return this;
}
public final void setRetainUntilDate(Instant retainUntilDate) {
this.retainUntilDate = retainUntilDate;
}
@Override
public ObjectLockRetention build() {
return new ObjectLockRetention(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy