software.amazon.awssdk.services.backup.model

Class BackupPlanInput

java.lang.Object

software.amazon.awssdk.services.backup.model.BackupPlanInput

All Implemented Interfaces:

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

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

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

Method Summary

Modifier and Type	Method and Description
List<AdvancedBackupSetting>	advancedBackupSettings() Specifies a list of BackupOptions for each resource type.
String	backupPlanName() The optional display name of a backup plan.
static BackupPlanInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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<BackupRuleInput>	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 BackupPlanInput.Builder>	serializableBuilderClass()
BackupPlanInput.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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 optional display name of a backup plan.

Returns:

The optional display name of a backup plan.

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<BackupRuleInput> 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()

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

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:

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

toBuilder

public BackupPlanInput.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<BackupPlanInput.Builder,BackupPlanInput>

Returns:

a builder for type T

builder

public static BackupPlanInput.Builder builder()

serializableBuilderClass

public static Class<? extends BackupPlanInput.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.