software.amazon.awssdk.services.redshiftserverless.model.CreateSnapshotScheduleActionParameters Maven / Gradle / Ivy
Show all versions of redshiftserverless 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.redshiftserverless.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;
/**
*
* The parameters that you can use to configure a scheduled
* action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateSnapshotScheduleActionParameters implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAMESPACE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("namespaceName").getter(getter(CreateSnapshotScheduleActionParameters::namespaceName))
.setter(setter(Builder::namespaceName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("namespaceName").build()).build();
private static final SdkField RETENTION_PERIOD_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("retentionPeriod").getter(getter(CreateSnapshotScheduleActionParameters::retentionPeriod))
.setter(setter(Builder::retentionPeriod))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("retentionPeriod").build()).build();
private static final SdkField SNAPSHOT_NAME_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("snapshotNamePrefix").getter(getter(CreateSnapshotScheduleActionParameters::snapshotNamePrefix))
.setter(setter(Builder::snapshotNamePrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("snapshotNamePrefix").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateSnapshotScheduleActionParameters::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAMESPACE_NAME_FIELD,
RETENTION_PERIOD_FIELD, SNAPSHOT_NAME_PREFIX_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String namespaceName;
private final Integer retentionPeriod;
private final String snapshotNamePrefix;
private final List tags;
private CreateSnapshotScheduleActionParameters(BuilderImpl builder) {
this.namespaceName = builder.namespaceName;
this.retentionPeriod = builder.retentionPeriod;
this.snapshotNamePrefix = builder.snapshotNamePrefix;
this.tags = builder.tags;
}
/**
*
* The name of the namespace for which you want to configure a scheduled action to create a snapshot.
*
*
* @return The name of the namespace for which you want to configure a scheduled action to create a snapshot.
*/
public final String namespaceName() {
return namespaceName;
}
/**
*
* The retention period of the snapshot created by the scheduled action.
*
*
* @return The retention period of the snapshot created by the scheduled action.
*/
public final Integer retentionPeriod() {
return retentionPeriod;
}
/**
*
* A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of
* the snapshot is the string prefix appended by the date and time of when the snapshot was created.
*
*
* @return A string prefix that is attached to the name of the snapshot created by the scheduled action. The final
* name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
*/
public final String snapshotNamePrefix() {
return snapshotNamePrefix;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* An array of Tag
* objects to associate with the snapshot.
*
*
* 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 #hasTags} method.
*
*
* @return An array of Tag objects
* to associate with the snapshot.
*/
public final List tags() {
return tags;
}
@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(namespaceName());
hashCode = 31 * hashCode + Objects.hashCode(retentionPeriod());
hashCode = 31 * hashCode + Objects.hashCode(snapshotNamePrefix());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 CreateSnapshotScheduleActionParameters)) {
return false;
}
CreateSnapshotScheduleActionParameters other = (CreateSnapshotScheduleActionParameters) obj;
return Objects.equals(namespaceName(), other.namespaceName())
&& Objects.equals(retentionPeriod(), other.retentionPeriod())
&& Objects.equals(snapshotNamePrefix(), other.snapshotNamePrefix()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateSnapshotScheduleActionParameters").add("NamespaceName", namespaceName())
.add("RetentionPeriod", retentionPeriod()).add("SnapshotNamePrefix", snapshotNamePrefix())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "namespaceName":
return Optional.ofNullable(clazz.cast(namespaceName()));
case "retentionPeriod":
return Optional.ofNullable(clazz.cast(retentionPeriod()));
case "snapshotNamePrefix":
return Optional.ofNullable(clazz.cast(snapshotNamePrefix()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateSnapshotScheduleActionParameters) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the namespace for which you want to configure a scheduled action to create a snapshot.
*
*
* @param namespaceName
* The name of the namespace for which you want to configure a scheduled action to create a snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder namespaceName(String namespaceName);
/**
*
* The retention period of the snapshot created by the scheduled action.
*
*
* @param retentionPeriod
* The retention period of the snapshot created by the scheduled action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder retentionPeriod(Integer retentionPeriod);
/**
*
* A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name
* of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
*
*
* @param snapshotNamePrefix
* A string prefix that is attached to the name of the snapshot created by the scheduled action. The
* final name of the snapshot is the string prefix appended by the date and time of when the snapshot was
* created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotNamePrefix(String snapshotNamePrefix);
/**
*
* An array of Tag
* objects to associate with the snapshot.
*
*
* @param tags
* An array of Tag
* objects to associate with the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* An array of Tag
* objects to associate with the snapshot.
*
*
* @param tags
* An array of Tag
* objects to associate with the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* An array of Tag
* objects to associate with the snapshot.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.redshiftserverless.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.redshiftserverless.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.redshiftserverless.model.Tag.Builder#build()} is called immediately
* and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.redshiftserverless.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
}
static final class BuilderImpl implements Builder {
private String namespaceName;
private Integer retentionPeriod;
private String snapshotNamePrefix;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateSnapshotScheduleActionParameters model) {
namespaceName(model.namespaceName);
retentionPeriod(model.retentionPeriod);
snapshotNamePrefix(model.snapshotNamePrefix);
tags(model.tags);
}
public final String getNamespaceName() {
return namespaceName;
}
public final void setNamespaceName(String namespaceName) {
this.namespaceName = namespaceName;
}
@Override
public final Builder namespaceName(String namespaceName) {
this.namespaceName = namespaceName;
return this;
}
public final Integer getRetentionPeriod() {
return retentionPeriod;
}
public final void setRetentionPeriod(Integer retentionPeriod) {
this.retentionPeriod = retentionPeriod;
}
@Override
public final Builder retentionPeriod(Integer retentionPeriod) {
this.retentionPeriod = retentionPeriod;
return this;
}
public final String getSnapshotNamePrefix() {
return snapshotNamePrefix;
}
public final void setSnapshotNamePrefix(String snapshotNamePrefix) {
this.snapshotNamePrefix = snapshotNamePrefix;
}
@Override
public final Builder snapshotNamePrefix(String snapshotNamePrefix) {
this.snapshotNamePrefix = snapshotNamePrefix;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public CreateSnapshotScheduleActionParameters build() {
return new CreateSnapshotScheduleActionParameters(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}