software.amazon.awssdk.services.backup.model

Class BackupPlan

java.lang.Object

software.amazon.awssdk.services.backup.model.BackupPlan

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BackupPlan.Builder,BackupPlan>

@Generated(value="software.amazon.awssdk:codegen")
public final class BackupPlan
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BackupPlan.Builder,BackupPlan>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BackupPlan.Builder

Method Summary

Modifier and Type	Method and Description
List<AdvancedBackupSetting>	advancedBackupSettings() Contains a list of BackupOptions for each resource type.
String	backupPlanName() The display name of a backup plan.
static BackupPlan.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdvancedBackupSettings() For responses, this returns true if the service returned a value for the AdvancedBackupSettings property.
int	hashCode()
boolean	hasRules() For responses, this returns true if the service returned a value for the Rules property.
List<BackupRule>	rules() An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
List<SdkField<?>>	sdkFields()
static Class<? extends BackupPlan.Builder>	serializableBuilderClass()
BackupPlan.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

backupPlanName

public final String backupPlanName()

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

Returns:

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

hasRules

public final boolean hasRules()

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 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.

rules

public final List<BackupRule> rules()

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 hasRules() method.

Returns:

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

hasAdvancedBackupSettings

public final boolean hasAdvancedBackupSettings()

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 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.

advancedBackupSettings

public final List<AdvancedBackupSetting> advancedBackupSettings()

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 hasAdvancedBackupSettings() method.

Returns:

Contains a list of BackupOptions for each resource type.

toBuilder

public BackupPlan.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BackupPlan.Builder,BackupPlan>

builder

public static BackupPlan.Builder builder()

serializableBuilderClass

public static Class<? extends BackupPlan.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo