software.amazon.awssdk.services.backup.model.BackupPlan Maven / Gradle / Ivy
Show all versions of backup 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.backup.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*
* Contains an optional backup plan display name and an array of BackupRule objects, each of which
* specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different
* selection of Amazon Web Services resources.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BackupPlan implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField BACKUP_PLAN_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("BackupPlanName").getter(getter(BackupPlan::backupPlanName)).setter(setter(Builder::backupPlanName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BackupPlanName").build()).build();
private static final SdkField> RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Rules")
.getter(getter(BackupPlan::rules))
.setter(setter(Builder::rules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Rules").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(BackupRule::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ADVANCED_BACKUP_SETTINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AdvancedBackupSettings")
.getter(getter(BackupPlan::advancedBackupSettings))
.setter(setter(Builder::advancedBackupSettings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AdvancedBackupSettings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AdvancedBackupSetting::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BACKUP_PLAN_NAME_FIELD,
RULES_FIELD, ADVANCED_BACKUP_SETTINGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String backupPlanName;
private final List rules;
private final List advancedBackupSettings;
private BackupPlan(BuilderImpl builder) {
this.backupPlanName = builder.backupPlanName;
this.rules = builder.rules;
this.advancedBackupSettings = builder.advancedBackupSettings;
}
/**
*
* The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.
*
*
* If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can
* contain 1 to 200 characters.
*
*
* @return The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.
*
* If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it
* can contain 1 to 200 characters.
*/
public final String backupPlanName() {
return backupPlanName;
}
/**
* For responses, this returns true if the service returned a value for the Rules 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 hasRules() {
return rules != null && !(rules instanceof SdkAutoConstructList);
}
/**
*
* An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a
* selection of resources.
*
*
* 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 #hasRules} method.
*
*
* @return An array of BackupRule objects, each of which specifies a scheduled task that is used to
* back up a selection of resources.
*/
public final List rules() {
return rules;
}
/**
* For responses, this returns true if the service returned a value for the AdvancedBackupSettings 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 hasAdvancedBackupSettings() {
return advancedBackupSettings != null && !(advancedBackupSettings instanceof SdkAutoConstructList);
}
/**
*
* Contains a list of BackupOptions for each resource type.
*
*
* 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 #hasAdvancedBackupSettings} method.
*
*
* @return Contains a list of BackupOptions for each resource type.
*/
public final List advancedBackupSettings() {
return advancedBackupSettings;
}
@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(backupPlanName());
hashCode = 31 * hashCode + Objects.hashCode(hasRules() ? rules() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAdvancedBackupSettings() ? advancedBackupSettings() : 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 BackupPlan)) {
return false;
}
BackupPlan other = (BackupPlan) obj;
return Objects.equals(backupPlanName(), other.backupPlanName()) && hasRules() == other.hasRules()
&& Objects.equals(rules(), other.rules()) && hasAdvancedBackupSettings() == other.hasAdvancedBackupSettings()
&& Objects.equals(advancedBackupSettings(), other.advancedBackupSettings());
}
/**
* 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("BackupPlan").add("BackupPlanName", backupPlanName()).add("Rules", hasRules() ? rules() : null)
.add("AdvancedBackupSettings", hasAdvancedBackupSettings() ? advancedBackupSettings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "BackupPlanName":
return Optional.ofNullable(clazz.cast(backupPlanName()));
case "Rules":
return Optional.ofNullable(clazz.cast(rules()));
case "AdvancedBackupSettings":
return Optional.ofNullable(clazz.cast(advancedBackupSettings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("BackupPlanName", BACKUP_PLAN_NAME_FIELD);
map.put("Rules", RULES_FIELD);
map.put("AdvancedBackupSettings", ADVANCED_BACKUP_SETTINGS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((BackupPlan) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.
*
*
* If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can
* contain 1 to 200 characters.
*
*
* @param backupPlanName
* The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.
*
* If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API,
* it can contain 1 to 200 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder backupPlanName(String backupPlanName);
/**
*
* An array of BackupRule objects, each of which specifies a scheduled task that is used to back up
* a selection of resources.
*
*
* @param rules
* An array of BackupRule objects, each of which specifies a scheduled task that is used to
* back up a selection of resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rules(Collection rules);
/**
*
* An array of BackupRule objects, each of which specifies a scheduled task that is used to back up
* a selection of resources.
*
*
* @param rules
* An array of BackupRule objects, each of which specifies a scheduled task that is used to
* back up a selection of resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rules(BackupRule... rules);
/**
*
* An array of BackupRule objects, each of which specifies a scheduled task that is used to back up
* a selection of resources.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.backup.model.BackupRule.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.backup.model.BackupRule#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.backup.model.BackupRule.Builder#build()} is called immediately and its
* result is passed to {@link #rules(List)}.
*
* @param rules
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.backup.model.BackupRule.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #rules(java.util.Collection)
*/
Builder rules(Consumer... rules);
/**
*
* Contains a list of BackupOptions for each resource type.
*
*
* @param advancedBackupSettings
* Contains a list of BackupOptions for each resource type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder advancedBackupSettings(Collection advancedBackupSettings);
/**
*
* Contains a list of BackupOptions for each resource type.
*
*
* @param advancedBackupSettings
* Contains a list of BackupOptions for each resource type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder advancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings);
/**
*
* Contains a list of BackupOptions for each resource type.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.backup.model.AdvancedBackupSetting.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.backup.model.AdvancedBackupSetting#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.backup.model.AdvancedBackupSetting.Builder#build()} is called
* immediately and its result is passed to {@link #advancedBackupSettings(List)}.
*
* @param advancedBackupSettings
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.backup.model.AdvancedBackupSetting.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #advancedBackupSettings(java.util.Collection)
*/
Builder advancedBackupSettings(Consumer... advancedBackupSettings);
}
static final class BuilderImpl implements Builder {
private String backupPlanName;
private List rules = DefaultSdkAutoConstructList.getInstance();
private List advancedBackupSettings = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BackupPlan model) {
backupPlanName(model.backupPlanName);
rules(model.rules);
advancedBackupSettings(model.advancedBackupSettings);
}
public final String getBackupPlanName() {
return backupPlanName;
}
public final void setBackupPlanName(String backupPlanName) {
this.backupPlanName = backupPlanName;
}
@Override
public final Builder backupPlanName(String backupPlanName) {
this.backupPlanName = backupPlanName;
return this;
}
public final List getRules() {
List result = BackupRulesCopier.copyToBuilder(this.rules);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRules(Collection rules) {
this.rules = BackupRulesCopier.copyFromBuilder(rules);
}
@Override
public final Builder rules(Collection rules) {
this.rules = BackupRulesCopier.copy(rules);
return this;
}
@Override
@SafeVarargs
public final Builder rules(BackupRule... rules) {
rules(Arrays.asList(rules));
return this;
}
@Override
@SafeVarargs
public final Builder rules(Consumer... rules) {
rules(Stream.of(rules).map(c -> BackupRule.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getAdvancedBackupSettings() {
List result = AdvancedBackupSettingsCopier.copyToBuilder(this.advancedBackupSettings);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAdvancedBackupSettings(Collection advancedBackupSettings) {
this.advancedBackupSettings = AdvancedBackupSettingsCopier.copyFromBuilder(advancedBackupSettings);
}
@Override
public final Builder advancedBackupSettings(Collection advancedBackupSettings) {
this.advancedBackupSettings = AdvancedBackupSettingsCopier.copy(advancedBackupSettings);
return this;
}
@Override
@SafeVarargs
public final Builder advancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings) {
advancedBackupSettings(Arrays.asList(advancedBackupSettings));
return this;
}
@Override
@SafeVarargs
public final Builder advancedBackupSettings(Consumer... advancedBackupSettings) {
advancedBackupSettings(Stream.of(advancedBackupSettings)
.map(c -> AdvancedBackupSetting.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public BackupPlan build() {
return new BackupPlan(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}