BackupJob (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.backup.model.BackupJob

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BackupJob
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains detailed information about a backup job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BackupJob()

Constructors
Constructor and Description
`BackupJob()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackupJob`	`addBackupOptionsEntry(String key, String value)` Add a single BackupOptions entry
`BackupJob`	`clearBackupOptionsEntries()` Removes all the entries added into BackupOptions.
`BackupJob`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()` The account ID that owns the backup job.
`String`	`getBackupJobId()` Uniquely identifies a request to Backup to back up a resource.
`Map<String,String>`	`getBackupOptions()` Specifies the backup option for a selected resource.
`Long`	`getBackupSizeInBytes()` The size, in bytes, of a backup.
`String`	`getBackupType()` Represents the type of backup for a backup job.
`String`	`getBackupVaultArn()` An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
`String`	`getBackupVaultName()` The name of a logical container where backups are stored.
`Long`	`getBytesTransferred()` The size in bytes transferred to a backup vault at the time that the job status was queried.
`Date`	`getCompletionDate()` The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).
`RecoveryPointCreator`	`getCreatedBy()` Contains identifying information about the creation of a backup job, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan used to create it.
`Date`	`getCreationDate()` The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC).
`Date`	`getExpectedCompletionDate()` The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC).
`String`	`getIamRoleArn()` Specifies the IAM role ARN used to create the target recovery point.
`Date`	`getInitiationDate()` This is the date on which the backup job was initiated.
`Boolean`	`getIsParent()` This is a boolean value indicating this is a parent (composite) backup job.
`String`	`getMessageCategory()` This parameter is the job count for the specified message category.
`String`	`getParentJobId()` This uniquely identifies a request to Backup to back up a resource.
`String`	`getPercentDone()` Contains an estimated percentage complete of a job at the time the job status was queried.
`String`	`getRecoveryPointArn()` An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`String`	`getResourceArn()` An ARN that uniquely identifies a resource.
`String`	`getResourceName()` This is the non-unique name of the resource that belongs to the specified backup.
`String`	`getResourceType()` The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
`Date`	`getStartBy()` Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled.
`String`	`getState()` The current state of a backup job.
`String`	`getStatusMessage()` A detailed message explaining the status of the job to back up a resource.
`int`	`hashCode()`
`Boolean`	`isParent()` This is a boolean value indicating this is a parent (composite) backup job.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountId(String accountId)` The account ID that owns the backup job.
`void`	`setBackupJobId(String backupJobId)` Uniquely identifies a request to Backup to back up a resource.
`void`	`setBackupOptions(Map<String,String> backupOptions)` Specifies the backup option for a selected resource.
`void`	`setBackupSizeInBytes(Long backupSizeInBytes)` The size, in bytes, of a backup.
`void`	`setBackupType(String backupType)` Represents the type of backup for a backup job.
`void`	`setBackupVaultArn(String backupVaultArn)` An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
`void`	`setBackupVaultName(String backupVaultName)` The name of a logical container where backups are stored.
`void`	`setBytesTransferred(Long bytesTransferred)` The size in bytes transferred to a backup vault at the time that the job status was queried.
`void`	`setCompletionDate(Date completionDate)` The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).
`void`	`setCreatedBy(RecoveryPointCreator createdBy)` Contains identifying information about the creation of a backup job, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan used to create it.
`void`	`setCreationDate(Date creationDate)` The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC).
`void`	`setExpectedCompletionDate(Date expectedCompletionDate)` The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC).
`void`	`setIamRoleArn(String iamRoleArn)` Specifies the IAM role ARN used to create the target recovery point.
`void`	`setInitiationDate(Date initiationDate)` This is the date on which the backup job was initiated.
`void`	`setIsParent(Boolean isParent)` This is a boolean value indicating this is a parent (composite) backup job.
`void`	`setMessageCategory(String messageCategory)` This parameter is the job count for the specified message category.
`void`	`setParentJobId(String parentJobId)` This uniquely identifies a request to Backup to back up a resource.
`void`	`setPercentDone(String percentDone)` Contains an estimated percentage complete of a job at the time the job status was queried.
`void`	`setRecoveryPointArn(String recoveryPointArn)` An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`void`	`setResourceArn(String resourceArn)` An ARN that uniquely identifies a resource.
`void`	`setResourceName(String resourceName)` This is the non-unique name of the resource that belongs to the specified backup.
`void`	`setResourceType(String resourceType)` The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
`void`	`setStartBy(Date startBy)` Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled.
`void`	`setState(String state)` The current state of a backup job.
`void`	`setStatusMessage(String statusMessage)` A detailed message explaining the status of the job to back up a resource.
`String`	`toString()` Returns a string representation of this object.
`BackupJob`	`withAccountId(String accountId)` The account ID that owns the backup job.
`BackupJob`	`withBackupJobId(String backupJobId)` Uniquely identifies a request to Backup to back up a resource.
`BackupJob`	`withBackupOptions(Map<String,String> backupOptions)` Specifies the backup option for a selected resource.
`BackupJob`	`withBackupSizeInBytes(Long backupSizeInBytes)` The size, in bytes, of a backup.
`BackupJob`	`withBackupType(String backupType)` Represents the type of backup for a backup job.
`BackupJob`	`withBackupVaultArn(String backupVaultArn)` An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
`BackupJob`	`withBackupVaultName(String backupVaultName)` The name of a logical container where backups are stored.
`BackupJob`	`withBytesTransferred(Long bytesTransferred)` The size in bytes transferred to a backup vault at the time that the job status was queried.
`BackupJob`	`withCompletionDate(Date completionDate)` The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).
`BackupJob`	`withCreatedBy(RecoveryPointCreator createdBy)` Contains identifying information about the creation of a backup job, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan used to create it.
`BackupJob`	`withCreationDate(Date creationDate)` The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC).
`BackupJob`	`withExpectedCompletionDate(Date expectedCompletionDate)` The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC).
`BackupJob`	`withIamRoleArn(String iamRoleArn)` Specifies the IAM role ARN used to create the target recovery point.
`BackupJob`	`withInitiationDate(Date initiationDate)` This is the date on which the backup job was initiated.
`BackupJob`	`withIsParent(Boolean isParent)` This is a boolean value indicating this is a parent (composite) backup job.
`BackupJob`	`withMessageCategory(String messageCategory)` This parameter is the job count for the specified message category.
`BackupJob`	`withParentJobId(String parentJobId)` This uniquely identifies a request to Backup to back up a resource.
`BackupJob`	`withPercentDone(String percentDone)` Contains an estimated percentage complete of a job at the time the job status was queried.
`BackupJob`	`withRecoveryPointArn(String recoveryPointArn)` An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`BackupJob`	`withResourceArn(String resourceArn)` An ARN that uniquely identifies a resource.
`BackupJob`	`withResourceName(String resourceName)` This is the non-unique name of the resource that belongs to the specified backup.
`BackupJob`	`withResourceType(String resourceType)` The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
`BackupJob`	`withStartBy(Date startBy)` Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled.
`BackupJob`	`withState(BackupJobState state)` The current state of a backup job.
`BackupJob`	`withState(String state)` The current state of a backup job.
`BackupJob`	`withStatusMessage(String statusMessage)` A detailed message explaining the status of the job to back up a resource.

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

- Constructor Detail
  - BackupJob
```
public BackupJob()
```
- Method Detail
  - setAccountId
```
public void setAccountId(String accountId)
```
    The account ID that owns the backup job.
    
    Parameters:
    
    accountId - The account ID that owns the backup job.
  - getAccountId
```
public String getAccountId()
```
    The account ID that owns the backup job.
    
    Returns:
    
    The account ID that owns the backup job.
  - withAccountId
```
public BackupJob withAccountId(String accountId)
```
    The account ID that owns the backup job.
    
    Parameters:
    
    accountId - The account ID that owns the backup job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupJobId
```
public void setBackupJobId(String backupJobId)
```
    Uniquely identifies a request to Backup to back up a resource.
    
    Parameters:
    
    backupJobId - Uniquely identifies a request to Backup to back up a resource.
  - getBackupJobId
```
public String getBackupJobId()
```
    Uniquely identifies a request to Backup to back up a resource.
    
    Returns:
    
    Uniquely identifies a request to Backup to back up a resource.
  - withBackupJobId
```
public BackupJob withBackupJobId(String backupJobId)
```
    Uniquely identifies a request to Backup to back up a resource.
    
    Parameters:
    
    backupJobId - Uniquely identifies a request to Backup to back up a resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupVaultName
```
public void setBackupVaultName(String backupVaultName)
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Parameters:
    
    backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
  - getBackupVaultName
```
public String getBackupVaultName()
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Returns:
    
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
  - withBackupVaultName
```
public BackupJob withBackupVaultName(String backupVaultName)
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Parameters:
    
    backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupVaultArn
```
public void setBackupVaultArn(String backupVaultArn)
```
    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    
    Parameters:
    
    backupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
  - getBackupVaultArn
```
public String getBackupVaultArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    
    Returns:
    
    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
  - withBackupVaultArn
```
public BackupJob withBackupVaultArn(String backupVaultArn)
```
    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    
    Parameters:
    
    backupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecoveryPointArn
```
public void setRecoveryPointArn(String recoveryPointArn)
```
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Parameters:
    
    recoveryPointArn - An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
  - getRecoveryPointArn
```
public String getRecoveryPointArn()
```
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Returns:
    
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
  - withRecoveryPointArn
```
public BackupJob withRecoveryPointArn(String recoveryPointArn)
```
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Parameters:
    
    recoveryPointArn - An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceArn
```
public void setResourceArn(String resourceArn)
```
    An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    resourceArn - An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - getResourceArn
```
public String getResourceArn()
```
    An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - withResourceArn
```
public BackupJob withResourceArn(String resourceArn)
```
    An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    resourceArn - An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    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 a backup job 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 a backup job 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 a backup job 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 a backup job 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 BackupJob withCreationDate(Date creationDate)
```
    The date and time a backup job 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 a backup job 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.
  - setCompletionDate
```
public void setCompletionDate(Date completionDate)
```
    The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    completionDate - The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - getCompletionDate
```
public Date getCompletionDate()
```
    The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate 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 a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - withCompletionDate
```
public BackupJob withCompletionDate(Date completionDate)
```
    The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    completionDate - The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate 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.
  - setState
```
public void setState(String state)
```
    The current state of a backup job.
    
    Parameters:
    
    state - The current state of a backup job.
    
    See Also:
    
    BackupJobState
  - getState
```
public String getState()
```
    The current state of a backup job.
    
    Returns:
    
    The current state of a backup job.
    
    See Also:
    
    BackupJobState
  - withState
```
public BackupJob withState(String state)
```
    The current state of a backup job.
    
    Parameters:
    
    state - The current state of a backup job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupJobState
  - withState
```
public BackupJob withState(BackupJobState state)
```
    The current state of a backup job.
    
    Parameters:
    
    state - The current state of a backup job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupJobState
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A detailed message explaining the status of the job to back up a resource.
    
    Parameters:
    
    statusMessage - A detailed message explaining the status of the job to back up a resource.
  - getStatusMessage
```
public String getStatusMessage()
```
    A detailed message explaining the status of the job to back up a resource.
    
    Returns:
    
    A detailed message explaining the status of the job to back up a resource.
  - withStatusMessage
```
public BackupJob withStatusMessage(String statusMessage)
```
    A detailed message explaining the status of the job to back up a resource.
    
    Parameters:
    
    statusMessage - A detailed message explaining the status of the job to back up a resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPercentDone
```
public void setPercentDone(String percentDone)
```
    Contains an estimated percentage complete of a job at the time the job status was queried.
    
    Parameters:
    
    percentDone - Contains an estimated percentage complete of a job at the time the job status was queried.
  - getPercentDone
```
public String getPercentDone()
```
    Contains an estimated percentage complete of a job at the time the job status was queried.
    
    Returns:
    
    Contains an estimated percentage complete of a job at the time the job status was queried.
  - withPercentDone
```
public BackupJob withPercentDone(String percentDone)
```
    Contains an estimated percentage complete of a job at the time the job status was queried.
    
    Parameters:
    
    percentDone - Contains an estimated percentage complete of a job at the time the job status was queried.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupSizeInBytes
```
public void setBackupSizeInBytes(Long backupSizeInBytes)
```
    The size, in bytes, of a backup.
    
    Parameters:
    
    backupSizeInBytes - The size, in bytes, of a backup.
  - getBackupSizeInBytes
```
public Long getBackupSizeInBytes()
```
    The size, in bytes, of a backup.
    
    Returns:
    
    The size, in bytes, of a backup.
  - withBackupSizeInBytes
```
public BackupJob withBackupSizeInBytes(Long backupSizeInBytes)
```
    The size, in bytes, of a backup.
    
    Parameters:
    
    backupSizeInBytes - The size, in bytes, of a backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamRoleArn
```
public void setIamRoleArn(String iamRoleArn)
```
    Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
    
    Parameters:
    
    iamRoleArn - Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
    
    Returns:
    
    Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
  - withIamRoleArn
```
public BackupJob withIamRoleArn(String iamRoleArn)
```
    Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
    
    Parameters:
    
    iamRoleArn - Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedBy
```
public void setCreatedBy(RecoveryPointCreator createdBy)
```
    Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
    
    Parameters:
    
    createdBy - Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
  - getCreatedBy
```
public RecoveryPointCreator getCreatedBy()
```
    Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
    
    Returns:
    
    Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
  - withCreatedBy
```
public BackupJob withCreatedBy(RecoveryPointCreator createdBy)
```
    Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
    
    Parameters:
    
    createdBy - Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpectedCompletionDate
```
public void setExpectedCompletionDate(Date expectedCompletionDate)
```
    The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    expectedCompletionDate - The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - getExpectedCompletionDate
```
public Date getExpectedCompletionDate()
```
    The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate 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 a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - withExpectedCompletionDate
```
public BackupJob withExpectedCompletionDate(Date expectedCompletionDate)
```
    The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    expectedCompletionDate - The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate 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.
  - setStartBy
```
public void setStartBy(Date startBy)
```
    Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    startBy - Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - getStartBy
```
public Date getStartBy()
```
    Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - withStartBy
```
public BackupJob withStartBy(Date startBy)
```
    Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    startBy - Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy 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.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
    
    Parameters:
    
    resourceType - The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
  - getResourceType
```
public String getResourceType()
```
    The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
    
    Returns:
    
    The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
  - withResourceType
```
public BackupJob withResourceType(String resourceType)
```
    The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
    
    Parameters:
    
    resourceType - The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBytesTransferred
```
public void setBytesTransferred(Long bytesTransferred)
```
    The size in bytes transferred to a backup vault at the time that the job status was queried.
    
    Parameters:
    
    bytesTransferred - The size in bytes transferred to a backup vault at the time that the job status was queried.
  - getBytesTransferred
```
public Long getBytesTransferred()
```
    The size in bytes transferred to a backup vault at the time that the job status was queried.
    
    Returns:
    
    The size in bytes transferred to a backup vault at the time that the job status was queried.
  - withBytesTransferred
```
public BackupJob withBytesTransferred(Long bytesTransferred)
```
    The size in bytes transferred to a backup vault at the time that the job status was queried.
    
    Parameters:
    
    bytesTransferred - The size in bytes transferred to a backup vault at the time that the job status was queried.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBackupOptions
```
public Map<String,String> getBackupOptions()
```
    Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
    
    Returns:
    
    Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
  - setBackupOptions
```
public void setBackupOptions(Map<String,String> backupOptions)
```
    Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
    
    Parameters:
    
    backupOptions - Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
  - withBackupOptions
```
public BackupJob withBackupOptions(Map<String,String> backupOptions)
```
    Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
    
    Parameters:
    
    backupOptions - Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addBackupOptionsEntry
```
public BackupJob addBackupOptionsEntry(String key,
                                       String value)
```
    Add a single BackupOptions entry
    
    See Also:
    
    withBackupOptions(java.util.Map<java.lang.String, java.lang.String>)
  - clearBackupOptionsEntries
```
public BackupJob clearBackupOptionsEntries()
```
    Removes all the entries added into BackupOptions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupType
```
public void setBackupType(String backupType)
```
    Represents the type of backup for a backup job.
    
    Parameters:
    
    backupType - Represents the type of backup for a backup job.
  - getBackupType
```
public String getBackupType()
```
    Represents the type of backup for a backup job.
    
    Returns:
    
    Represents the type of backup for a backup job.
  - withBackupType
```
public BackupJob withBackupType(String backupType)
```
    Represents the type of backup for a backup job.
    
    Parameters:
    
    backupType - Represents the type of backup for a backup job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParentJobId
```
public void setParentJobId(String parentJobId)
```
    This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
    
    Parameters:
    
    parentJobId - This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
  - getParentJobId
```
public String getParentJobId()
```
    This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
    
    Returns:
    
    This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
  - withParentJobId
```
public BackupJob withParentJobId(String parentJobId)
```
    This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
    
    Parameters:
    
    parentJobId - This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsParent
```
public void setIsParent(Boolean isParent)
```
    This is a boolean value indicating this is a parent (composite) backup job.
    
    Parameters:
    
    isParent - This is a boolean value indicating this is a parent (composite) backup job.
  - getIsParent
```
public Boolean getIsParent()
```
    This is a boolean value indicating this is a parent (composite) backup job.
    
    Returns:
    
    This is a boolean value indicating this is a parent (composite) backup job.
  - withIsParent
```
public BackupJob withIsParent(Boolean isParent)
```
    This is a boolean value indicating this is a parent (composite) backup job.
    
    Parameters:
    
    isParent - This is a boolean value indicating this is a parent (composite) backup job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isParent
```
public Boolean isParent()
```
    This is a boolean value indicating this is a parent (composite) backup job.
    
    Returns:
    
    This is a boolean value indicating this is a parent (composite) backup job.
  - setResourceName
```
public void setResourceName(String resourceName)
```
    This is the non-unique name of the resource that belongs to the specified backup.
    
    Parameters:
    
    resourceName - This is the non-unique name of the resource that belongs to the specified backup.
  - getResourceName
```
public String getResourceName()
```
    This is the non-unique name of the resource that belongs to the specified backup.
    
    Returns:
    
    This is the non-unique name of the resource that belongs to the specified backup.
  - withResourceName
```
public BackupJob withResourceName(String resourceName)
```
    This is the non-unique name of the resource that belongs to the specified backup.
    
    Parameters:
    
    resourceName - This is the non-unique name of the resource that belongs to the specified backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInitiationDate
```
public void setInitiationDate(Date initiationDate)
```
    This is the date on which the backup job was initiated.
    
    Parameters:
    
    initiationDate - This is the date on which the backup job was initiated.
  - getInitiationDate
```
public Date getInitiationDate()
```
    This is the date on which the backup job was initiated.
    
    Returns:
    
    This is the date on which the backup job was initiated.
  - withInitiationDate
```
public BackupJob withInitiationDate(Date initiationDate)
```
    This is the date on which the backup job was initiated.
    
    Parameters:
    
    initiationDate - This is the date on which the backup job was initiated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageCategory
```
public void setMessageCategory(String messageCategory)
```
    This parameter is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
    
    The the value ANY returns count of all message categories.
    
    AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
    
    Parameters:
    
    messageCategory - This parameter is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
    
    The the value ANY returns count of all message categories.
    
    AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
  - getMessageCategory
```
public String getMessageCategory()
```
    This parameter is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
    
    The the value ANY returns count of all message categories.
    
    AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
    
    Returns:
    
    This parameter is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
    
    The the value ANY returns count of all message categories.
    
    AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
  - withMessageCategory
```
public BackupJob withMessageCategory(String messageCategory)
```
    This parameter is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
    
    The the value ANY returns count of all message categories.
    
    AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
    
    Parameters:
    
    messageCategory - This parameter is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
    
    The the value ANY returns count of all message categories.
    
    AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
    
    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 BackupJob clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class BackupJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BackupJob

Method Detail

setAccountId

getAccountId

withAccountId

setBackupJobId

getBackupJobId

withBackupJobId

setBackupVaultName

getBackupVaultName

withBackupVaultName

setBackupVaultArn

getBackupVaultArn

withBackupVaultArn

setRecoveryPointArn

getRecoveryPointArn

withRecoveryPointArn

setResourceArn

getResourceArn

withResourceArn

setCreationDate

getCreationDate

withCreationDate

setCompletionDate

getCompletionDate

withCompletionDate

setState

getState

withState

withState

setStatusMessage

getStatusMessage

withStatusMessage

setPercentDone

getPercentDone

withPercentDone

setBackupSizeInBytes

getBackupSizeInBytes

withBackupSizeInBytes

setIamRoleArn

getIamRoleArn

withIamRoleArn

setCreatedBy

getCreatedBy

withCreatedBy

setExpectedCompletionDate

getExpectedCompletionDate

withExpectedCompletionDate

setStartBy

getStartBy

withStartBy

setResourceType

getResourceType

withResourceType

setBytesTransferred

getBytesTransferred

withBytesTransferred

getBackupOptions

setBackupOptions

withBackupOptions

addBackupOptionsEntry

clearBackupOptionsEntries

setBackupType

getBackupType

withBackupType

setParentJobId

getParentJobId

withParentJobId

setIsParent

getIsParent

withIsParent

isParent

setResourceName

getResourceName