software.amazon.awssdk.services.fsx.model.AutoImportPolicy Maven / Gradle / Ivy
Show all versions of fsx 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.fsx.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.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.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 the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx
* keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file
* system as you modify objects in a linked S3 bucket.
*
*
* The AutoImportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository
* association.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AutoImportPolicy implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> EVENTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Events")
.getter(getter(AutoImportPolicy::eventsAsStrings))
.setter(setter(Builder::eventsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Events").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(EVENTS_FIELD));
private static final long serialVersionUID = 1L;
private final List events;
private AutoImportPolicy(BuilderImpl builder) {
this.events = builder.events;
}
/**
*
* The AutoImportPolicy can have the following event values:
*
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not
* currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on
* the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are
* deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasEvents} method.
*
*
* @return The AutoImportPolicy can have the following event values:
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that
* do not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file
* content on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding files
* are deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
*/
public final List events() {
return EventTypesCopier.copyStringToEnum(events);
}
/**
* For responses, this returns true if the service returned a value for the Events property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasEvents() {
return events != null && !(events instanceof SdkAutoConstructList);
}
/**
*
* The AutoImportPolicy can have the following event values:
*
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not
* currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on
* the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are
* deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasEvents} method.
*
*
* @return The AutoImportPolicy can have the following event values:
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that
* do not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file
* content on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding files
* are deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
*/
public final List eventsAsStrings() {
return events;
}
@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 + Objects.hashCode(hasEvents() ? eventsAsStrings() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AutoImportPolicy)) {
return false;
}
AutoImportPolicy other = (AutoImportPolicy) obj;
return hasEvents() == other.hasEvents() && Objects.equals(eventsAsStrings(), other.eventsAsStrings());
}
/**
* 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("AutoImportPolicy").add("Events", hasEvents() ? eventsAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Events":
return Optional.ofNullable(clazz.cast(eventsAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AutoImportPolicy) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The AutoImportPolicy can have the following event values:
*
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do
* not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content
* on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are
* deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
*
*
* @param events
* The AutoImportPolicy can have the following event values:
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket
* that do not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file
* content on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding
* files are deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventsWithStrings(Collection events);
/**
*
* The AutoImportPolicy can have the following event values:
*
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do
* not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content
* on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are
* deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
*
*
* @param events
* The AutoImportPolicy can have the following event values:
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket
* that do not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file
* content on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding
* files are deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventsWithStrings(String... events);
/**
*
* The AutoImportPolicy can have the following event values:
*
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do
* not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content
* on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are
* deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
*
*
* @param events
* The AutoImportPolicy can have the following event values:
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket
* that do not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file
* content on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding
* files are deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder events(Collection events);
/**
*
* The AutoImportPolicy can have the following event values:
*
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do
* not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content
* on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are
* deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
*
*
* @param events
* The AutoImportPolicy can have the following event values:
*
* -
*
* NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket
* that do not currently exist in the FSx file system.
*
*
* -
*
* CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file
* content on the file system as files change in the data repository.
*
*
* -
*
* DELETED - Amazon FSx automatically deletes files on the file system as corresponding
* files are deleted in the data repository.
*
*
*
*
* You can define any combination of event types for your AutoImportPolicy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder events(EventType... events);
}
static final class BuilderImpl implements Builder {
private List events = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AutoImportPolicy model) {
eventsWithStrings(model.events);
}
public final Collection getEvents() {
if (events instanceof SdkAutoConstructList) {
return null;
}
return events;
}
public final void setEvents(Collection events) {
this.events = EventTypesCopier.copy(events);
}
@Override
public final Builder eventsWithStrings(Collection events) {
this.events = EventTypesCopier.copy(events);
return this;
}
@Override
@SafeVarargs
public final Builder eventsWithStrings(String... events) {
eventsWithStrings(Arrays.asList(events));
return this;
}
@Override
public final Builder events(Collection events) {
this.events = EventTypesCopier.copyEnumToString(events);
return this;
}
@Override
@SafeVarargs
public final Builder events(EventType... events) {
events(Arrays.asList(events));
return this;
}
@Override
public AutoImportPolicy build() {
return new AutoImportPolicy(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}