GetBackupPlanResult (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.backup.model

Class GetBackupPlanResult

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.backup.model.GetBackupPlanResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetBackupPlanResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetBackupPlanResult ()

Constructors
Constructor and Description
`GetBackupPlanResult ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`GetBackupPlanResult`	`clone ()`
`boolean`	`equals (Object obj)`
`List<AdvancedBackupSetting>`	`getAdvancedBackupSettings ()` Contains a list of `BackupOptions` for each resource type.
`BackupPlan`	`getBackupPlan ()` Specifies the body of a backup plan.
`String`	`getBackupPlanArn ()` 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`.
`String`	`getBackupPlanId ()` Uniquely identifies a backup plan.
`Date`	`getCreationDate ()` The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC).
`String`	`getCreatorRequestId ()` A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
`Date`	`getDeletionDate ()` The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).
`Date`	`getLastExecutionDate ()` The last time a job to back up resources was run with this backup plan.
`String`	`getVersionId ()` Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.
`int`	`hashCode ()`
`void`	`setAdvancedBackupSettings (Collection<AdvancedBackupSetting> advancedBackupSettings)` Contains a list of `BackupOptions` for each resource type.
`void`	`setBackupPlan (BackupPlan backupPlan)` Specifies the body of a backup plan.
`void`	`setBackupPlanArn (String 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`.
`void`	`setBackupPlanId (String backupPlanId)` Uniquely identifies a backup plan.
`void`	`setCreationDate (Date creationDate)` The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC).
`void`	`setCreatorRequestId (String creatorRequestId)` A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
`void`	`setDeletionDate (Date deletionDate)` The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).
`void`	`setLastExecutionDate (Date lastExecutionDate)` The last time a job to back up resources was run with this backup plan.
`void`	`setVersionId (String versionId)` Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.
`String`	`toString ()` Returns a string representation of this object.
`GetBackupPlanResult`	`withAdvancedBackupSettings (AdvancedBackupSetting... advancedBackupSettings)` Contains a list of `BackupOptions` for each resource type.
`GetBackupPlanResult`	`withAdvancedBackupSettings (Collection<AdvancedBackupSetting> advancedBackupSettings)` Contains a list of `BackupOptions` for each resource type.
`GetBackupPlanResult`	`withBackupPlan (BackupPlan backupPlan)` Specifies the body of a backup plan.
`GetBackupPlanResult`	`withBackupPlanArn (String 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`.
`GetBackupPlanResult`	`withBackupPlanId (String backupPlanId)` Uniquely identifies a backup plan.
`GetBackupPlanResult`	`withCreationDate (Date creationDate)` The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC).
`GetBackupPlanResult`	`withCreatorRequestId (String creatorRequestId)` A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
`GetBackupPlanResult`	`withDeletionDate (Date deletionDate)` The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC).
`GetBackupPlanResult`	`withLastExecutionDate (Date lastExecutionDate)` The last time a job to back up resources was run with this backup plan.
`GetBackupPlanResult`	`withVersionId (String versionId)` Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetBackupPlanResult
```
public GetBackupPlanResult()
```
- Method Detail
  - setBackupPlan
```
public void setBackupPlan(BackupPlan backupPlan)
```
    Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
    
    Parameters:
    
    backupPlan - Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
  - getBackupPlan
```
public BackupPlan getBackupPlan()
```
    Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
    
    Returns:
    
    Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
  - withBackupPlan
```
public GetBackupPlanResult withBackupPlan(BackupPlan backupPlan)
```
    Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
    
    Parameters:
    
    backupPlan - Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupPlanId
```
public void setBackupPlanId(String backupPlanId)
```
    Uniquely identifies a backup plan.
    
    Parameters:
    
    backupPlanId - Uniquely identifies a backup plan.
  - getBackupPlanId
```
public String getBackupPlanId()
```
    Uniquely identifies a backup plan.
    
    Returns:
    
    Uniquely identifies a backup plan.
  - withBackupPlanId
```
public GetBackupPlanResult withBackupPlanId(String backupPlanId)
```
    Uniquely identifies a backup plan.
    
    Parameters:
    
    backupPlanId - Uniquely identifies a backup plan.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupPlanArn
```
public void setBackupPlanArn(String 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.
    
    Parameters:
    
    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.
  - getBackupPlanArn
```
public String getBackupPlanArn()
```
    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.
  - withBackupPlanArn
```
public GetBackupPlanResult withBackupPlanArn(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionId
```
public void setVersionId(String versionId)
```
    Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
    
    Parameters:
    
    versionId - Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
  - getVersionId
```
public String getVersionId()
```
    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.
  - withVersionId
```
public GetBackupPlanResult withVersionId(String versionId)
```
    Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
    
    Parameters:
    
    versionId - Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatorRequestId
```
public void setCreatorRequestId(String creatorRequestId)
```
    A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
    
    Parameters:
    
    creatorRequestId - A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
  - getCreatorRequestId
```
public String getCreatorRequestId()
```
    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.
  - withCreatorRequestId
```
public GetBackupPlanResult withCreatorRequestId(String creatorRequestId)
```
    A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
    
    Parameters:
    
    creatorRequestId - A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date 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.
    
    Parameters:
    
    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.
  - getCreationDate
```
public Date getCreationDate()
```
    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.
  - withCreationDate
```
public GetBackupPlanResult withCreationDate(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeletionDate
```
public void setDeletionDate(Date 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.
    
    Parameters:
    
    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.
  - getDeletionDate
```
public Date getDeletionDate()
```
    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.
  - withDeletionDate
```
public GetBackupPlanResult withDeletionDate(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastExecutionDate
```
public void setLastExecutionDate(Date 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.
    
    Parameters:
    
    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.
  - getLastExecutionDate
```
public Date getLastExecutionDate()
```
    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.
  - withLastExecutionDate
```
public GetBackupPlanResult withLastExecutionDate(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdvancedBackupSettings
```
public List<AdvancedBackupSetting> getAdvancedBackupSettings()
```
    Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.
    
    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.
  - setAdvancedBackupSettings
```
public void setAdvancedBackupSettings(Collection<AdvancedBackupSetting> 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.
    
    Parameters:
    
    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.
  - withAdvancedBackupSettings
```
public GetBackupPlanResult withAdvancedBackupSettings(AdvancedBackupSetting... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdvancedBackupSettings(java.util.Collection) or withAdvancedBackupSettings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdvancedBackupSettings
```
public GetBackupPlanResult withAdvancedBackupSettings(Collection<AdvancedBackupSetting> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetBackupPlanResult clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class GetBackupPlanResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetBackupPlanResult

Method Detail

setBackupPlan

getBackupPlan

withBackupPlan

setBackupPlanId

getBackupPlanId

withBackupPlanId

setBackupPlanArn

getBackupPlanArn

withBackupPlanArn

setVersionId

getVersionId

withVersionId

setCreatorRequestId

getCreatorRequestId

withCreatorRequestId

setCreationDate

getCreationDate

withCreationDate

setDeletionDate

getDeletionDate

withDeletionDate

setLastExecutionDate

getLastExecutionDate

withLastExecutionDate

getAdvancedBackupSettings

setAdvancedBackupSettings

withAdvancedBackupSettings

withAdvancedBackupSettings

toString

equals

hashCode

clone