Class GetBackupPlanResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetBackupPlanResponse.Builder,
GetBackupPlanResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AdvancedBackupSetting> Contains a list ofBackupOptions
for each resource type.final BackupPlan
Specifies the body of a backup plan.final String
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.final String
Uniquely identifies a backup plan.builder()
final Instant
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC).final String
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.final Instant
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).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) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the AdvancedBackupSettings property.final int
hashCode()
final Instant
The last time a job to back up resources was run with this backup plan.static Class
<? extends GetBackupPlanResponse.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.final String
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.Methods inherited from class software.amazon.awssdk.services.backup.model.BackupResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
backupPlan
Specifies the body of a backup plan. Includes a
BackupPlanName
and one or more sets ofRules
.- Returns:
- Specifies the body of a backup plan. Includes a
BackupPlanName
and one or more sets ofRules
.
-
backupPlanId
Uniquely identifies a backup plan.
- Returns:
- Uniquely identifies a backup plan.
-
backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.- Returns:
- An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
-
versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
- Returns:
- Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
-
creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
- Returns:
- A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
-
creationDate
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The
value of
CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
-
deletionDate
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of
DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The
value of
DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
-
lastExecutionDate
The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of
LastExecutionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- The last time a job to back up resources was run with this backup plan. A date and time, in Unix format
and Coordinated Universal Time (UTC). The value of
LastExecutionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
-
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
Contains a list of
BackupOptions
for each resource type. The list is populated only if the advanced option is set for the backup plan.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. The list is populated only if the advanced option is set for the backup plan.
-
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<GetBackupPlanResponse.Builder,
GetBackupPlanResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-