Class BackupPlanInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AdvancedBackupSetting> Specifies a list ofBackupOptions
for each resource type.final String
The display name of a backup plan.static BackupPlanInput.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdvancedBackupSettings property.final int
hashCode()
final boolean
hasRules()
For responses, this returns true if the service returned a value for the Rules property.final List
<BackupRuleInput> rules()
An array ofBackupRule
objects, each of which specifies a scheduled task that is used to back up a selection of resources.static Class
<? extends BackupPlanInput.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<BackupPlanInput.Builder,
BackupPlanInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-