DescribeBackupJobResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeBackupJobResult()

Constructors
Constructor and Description
`DescribeBackupJobResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeBackupJobResult`	`addBackupOptionsEntry(String key, String value)` Add a single BackupOptions entry
`DescribeBackupJobResult`	`addChildJobsInStateEntry(String key, Long value)` Add a single ChildJobsInState entry
`DescribeBackupJobResult`	`clearBackupOptionsEntries()` Removes all the entries added into BackupOptions.
`DescribeBackupJobResult`	`clearChildJobsInStateEntries()` Removes all the entries added into ChildJobsInState.
`DescribeBackupJobResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()` Returns 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()` Represents the options specified as part of backup plan or on-demand backup job.
`Long`	`getBackupSizeInBytes()` The size, in bytes, of a backup.
`String`	`getBackupType()` Represents the actual backup type selected 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.
`Map<String,Long>`	`getChildJobsInState()` This returns the statistics of the included child (nested) backup jobs.
`Date`	`getCompletionDate()` The date and time that 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 that is used to create it.
`Date`	`getCreationDate()` The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC).
`Date`	`getExpectedCompletionDate()` The date and time that 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; for example, `arn:aws:iam::123456789012:role/S3Access`.
`Date`	`getInitiationDate()` This is the date a backup job was initiated.
`Boolean`	`getIsParent()` This returns the boolean value that a backup job is a parent (composite) job.
`String`	`getMessageCategory()` This is the job count for the specified message category.
`Long`	`getNumberOfChildJobs()` This returns the number of child (nested) backup jobs.
`String`	`getParentJobId()` This returns the parent (composite) resource backup job ID.
`String`	`getPercentDone()` Contains an estimated percentage that is 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 saved 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 returns the boolean value that a backup job is a parent (composite) job.
`void`	`setAccountId(String accountId)` Returns 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)` Represents the options specified as part of backup plan or on-demand backup job.
`void`	`setBackupSizeInBytes(Long backupSizeInBytes)` The size, in bytes, of a backup.
`void`	`setBackupType(String backupType)` Represents the actual backup type selected 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`	`setChildJobsInState(Map<String,Long> childJobsInState)` This returns the statistics of the included child (nested) backup jobs.
`void`	`setCompletionDate(Date completionDate)` The date and time that 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 that is used to create it.
`void`	`setCreationDate(Date creationDate)` The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC).
`void`	`setExpectedCompletionDate(Date expectedCompletionDate)` The date and time that 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; for example, `arn:aws:iam::123456789012:role/S3Access`.
`void`	`setInitiationDate(Date initiationDate)` This is the date a backup job was initiated.
`void`	`setIsParent(Boolean isParent)` This returns the boolean value that a backup job is a parent (composite) job.
`void`	`setMessageCategory(String messageCategory)` This is the job count for the specified message category.
`void`	`setNumberOfChildJobs(Long numberOfChildJobs)` This returns the number of child (nested) backup jobs.
`void`	`setParentJobId(String parentJobId)` This returns the parent (composite) resource backup job ID.
`void`	`setPercentDone(String percentDone)` Contains an estimated percentage that is 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 saved 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.
`DescribeBackupJobResult`	`withAccountId(String accountId)` Returns the account ID that owns the backup job.
`DescribeBackupJobResult`	`withBackupJobId(String backupJobId)` Uniquely identifies a request to Backup to back up a resource.
`DescribeBackupJobResult`	`withBackupOptions(Map<String,String> backupOptions)` Represents the options specified as part of backup plan or on-demand backup job.
`DescribeBackupJobResult`	`withBackupSizeInBytes(Long backupSizeInBytes)` The size, in bytes, of a backup.
`DescribeBackupJobResult`	`withBackupType(String backupType)` Represents the actual backup type selected for a backup job.
`DescribeBackupJobResult`	`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`.
`DescribeBackupJobResult`	`withBackupVaultName(String backupVaultName)` The name of a logical container where backups are stored.
`DescribeBackupJobResult`	`withBytesTransferred(Long bytesTransferred)` The size in bytes transferred to a backup vault at the time that the job status was queried.
`DescribeBackupJobResult`	`withChildJobsInState(Map<String,Long> childJobsInState)` This returns the statistics of the included child (nested) backup jobs.
`DescribeBackupJobResult`	`withCompletionDate(Date completionDate)` The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).
`DescribeBackupJobResult`	`withCreatedBy(RecoveryPointCreator createdBy)` Contains identifying information about the creation of a backup job, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan that is used to create it.
`DescribeBackupJobResult`	`withCreationDate(Date creationDate)` The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC).
`DescribeBackupJobResult`	`withExpectedCompletionDate(Date expectedCompletionDate)` The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC).
`DescribeBackupJobResult`	`withIamRoleArn(String iamRoleArn)` Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`DescribeBackupJobResult`	`withInitiationDate(Date initiationDate)` This is the date a backup job was initiated.
`DescribeBackupJobResult`	`withIsParent(Boolean isParent)` This returns the boolean value that a backup job is a parent (composite) job.
`DescribeBackupJobResult`	`withMessageCategory(String messageCategory)` This is the job count for the specified message category.
`DescribeBackupJobResult`	`withNumberOfChildJobs(Long numberOfChildJobs)` This returns the number of child (nested) backup jobs.
`DescribeBackupJobResult`	`withParentJobId(String parentJobId)` This returns the parent (composite) resource backup job ID.
`DescribeBackupJobResult`	`withPercentDone(String percentDone)` Contains an estimated percentage that is complete of a job at the time the job status was queried.
`DescribeBackupJobResult`	`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`.
`DescribeBackupJobResult`	`withResourceArn(String resourceArn)` An ARN that uniquely identifies a saved resource.
`DescribeBackupJobResult`	`withResourceName(String resourceName)` This is the non-unique name of the resource that belongs to the specified backup.
`DescribeBackupJobResult`	`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.
`DescribeBackupJobResult`	`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.
`DescribeBackupJobResult`	`withState(BackupJobState state)` The current state of a backup job.
`DescribeBackupJobResult`	`withState(String state)` The current state of a backup job.
`DescribeBackupJobResult`	`withStatusMessage(String statusMessage)` A detailed message explaining the status of the job to back up a resource.

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
  - DescribeBackupJobResult
```
public DescribeBackupJobResult()
```
- Method Detail
  - setAccountId
```
public void setAccountId(String accountId)
```
    Returns the account ID that owns the backup job.
    
    Parameters:
    
    accountId - Returns the account ID that owns the backup job.
  - getAccountId
```
public String getAccountId()
```
    Returns the account ID that owns the backup job.
    
    Returns:
    
    Returns the account ID that owns the backup job.
  - withAccountId
```
public DescribeBackupJobResult withAccountId(String accountId)
```
    Returns the account ID that owns the backup job.
    
    Parameters:
    
    accountId - Returns 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 DescribeBackupJobResult 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 DescribeBackupJobResult 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 DescribeBackupJobResult 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 DescribeBackupJobResult 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 saved resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    resourceArn - An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
  - getResourceArn
```
public String getResourceArn()
```
    An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
  - withResourceArn
```
public DescribeBackupJobResult withResourceArn(String resourceArn)
```
    An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    resourceArn - An ARN that uniquely identifies a saved 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 that 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 that 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 that 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 that 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 DescribeBackupJobResult withCreationDate(Date creationDate)
```
    The date and time that 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 that 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 that 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 that 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 that 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 that 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 DescribeBackupJobResult withCompletionDate(Date completionDate)
```
    The date and time that 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 that 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 DescribeBackupJobResult 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 DescribeBackupJobResult 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 DescribeBackupJobResult 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 that is complete of a job at the time the job status was queried.
    
    Parameters:
    
    percentDone - Contains an estimated percentage that is complete of a job at the time the job status was queried.
  - getPercentDone
```
public String getPercentDone()
```
    Contains an estimated percentage that is complete of a job at the time the job status was queried.
    
    Returns:
    
    Contains an estimated percentage that is complete of a job at the time the job status was queried.
  - withPercentDone
```
public DescribeBackupJobResult withPercentDone(String percentDone)
```
    Contains an estimated percentage that is complete of a job at the time the job status was queried.
    
    Parameters:
    
    percentDone - Contains an estimated percentage that is 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 DescribeBackupJobResult 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; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Parameters:
    
    iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Returns:
    
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  - withIamRoleArn
```
public DescribeBackupJobResult withIamRoleArn(String iamRoleArn)
```
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Parameters:
    
    iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    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 that is 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 that is 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 that is 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 that is used to create it.
  - withCreatedBy
```
public DescribeBackupJobResult withCreatedBy(RecoveryPointCreator createdBy)
```
    Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is 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 that is used to create it.
    
    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.
    
    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.
  - 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.
    
    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.
  - withResourceType
```
public DescribeBackupJobResult 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.
    
    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.
    
    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 DescribeBackupJobResult 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.
  - setExpectedCompletionDate
```
public void setExpectedCompletionDate(Date expectedCompletionDate)
```
    The date and time that 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 that 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 that 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 that 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 DescribeBackupJobResult withExpectedCompletionDate(Date expectedCompletionDate)
```
    The date and time that 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 that 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 DescribeBackupJobResult 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.
  - getBackupOptions
```
public Map<String,String> getBackupOptions()
```
    Represents the options specified as part of backup plan or on-demand backup job.
    
    Returns:
    
    Represents the options specified as part of backup plan or on-demand backup job.
  - setBackupOptions
```
public void setBackupOptions(Map<String,String> backupOptions)
```
    Represents the options specified as part of backup plan or on-demand backup job.
    
    Parameters:
    
    backupOptions - Represents the options specified as part of backup plan or on-demand backup job.
  - withBackupOptions
```
public DescribeBackupJobResult withBackupOptions(Map<String,String> backupOptions)
```
    Represents the options specified as part of backup plan or on-demand backup job.
    
    Parameters:
    
    backupOptions - Represents the options specified as part of backup plan or on-demand backup job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addBackupOptionsEntry
```
public DescribeBackupJobResult addBackupOptionsEntry(String key,
                                                     String value)
```
    Add a single BackupOptions entry
    
    See Also:
    
    withBackupOptions(java.util.Map<java.lang.String, java.lang.String>)
  - clearBackupOptionsEntries
```
public DescribeBackupJobResult 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 actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.
    
    Parameters:
    
    backupType - Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.
  - getBackupType
```
public String getBackupType()
```
    Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.
    
    Returns:
    
    Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.
  - withBackupType
```
public DescribeBackupJobResult withBackupType(String backupType)
```
    Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.
    
    Parameters:
    
    backupType - Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParentJobId
```
public void setParentJobId(String parentJobId)
```
    This returns the parent (composite) resource backup job ID.
    
    Parameters:
    
    parentJobId - This returns the parent (composite) resource backup job ID.
  - getParentJobId
```
public String getParentJobId()
```
    This returns the parent (composite) resource backup job ID.
    
    Returns:
    
    This returns the parent (composite) resource backup job ID.
  - withParentJobId
```
public DescribeBackupJobResult withParentJobId(String parentJobId)
```
    This returns the parent (composite) resource backup job ID.
    
    Parameters:
    
    parentJobId - This returns the parent (composite) resource backup job ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsParent
```
public void setIsParent(Boolean isParent)
```
    This returns the boolean value that a backup job is a parent (composite) job.
    
    Parameters:
    
    isParent - This returns the boolean value that a backup job is a parent (composite) job.
  - getIsParent
```
public Boolean getIsParent()
```
    This returns the boolean value that a backup job is a parent (composite) job.
    
    Returns:
    
    This returns the boolean value that a backup job is a parent (composite) job.
  - withIsParent
```
public DescribeBackupJobResult withIsParent(Boolean isParent)
```
    This returns the boolean value that a backup job is a parent (composite) job.
    
    Parameters:
    
    isParent - This returns the boolean value that a backup job is a parent (composite) job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isParent
```
public Boolean isParent()
```
    This returns the boolean value that a backup job is a parent (composite) job.
    
    Returns:
    
    This returns the boolean value that a backup job is a parent (composite) job.
  - setNumberOfChildJobs
```
public void setNumberOfChildJobs(Long numberOfChildJobs)
```
    This returns the number of child (nested) backup jobs.
    
    Parameters:
    
    numberOfChildJobs - This returns the number of child (nested) backup jobs.
  - getNumberOfChildJobs
```
public Long getNumberOfChildJobs()
```
    This returns the number of child (nested) backup jobs.
    
    Returns:
    
    This returns the number of child (nested) backup jobs.
  - withNumberOfChildJobs
```
public DescribeBackupJobResult withNumberOfChildJobs(Long numberOfChildJobs)
```
    This returns the number of child (nested) backup jobs.
    
    Parameters:
    
    numberOfChildJobs - This returns the number of child (nested) backup jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getChildJobsInState
```
public Map<String,Long> getChildJobsInState()
```
    This returns the statistics of the included child (nested) backup jobs.
    
    Returns:
    
    This returns the statistics of the included child (nested) backup jobs.
  - setChildJobsInState
```
public void setChildJobsInState(Map<String,Long> childJobsInState)
```
    This returns the statistics of the included child (nested) backup jobs.
    
    Parameters:
    
    childJobsInState - This returns the statistics of the included child (nested) backup jobs.
  - withChildJobsInState
```
public DescribeBackupJobResult withChildJobsInState(Map<String,Long> childJobsInState)
```
    This returns the statistics of the included child (nested) backup jobs.
    
    Parameters:
    
    childJobsInState - This returns the statistics of the included child (nested) backup jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addChildJobsInStateEntry
```
public DescribeBackupJobResult addChildJobsInStateEntry(String key,
                                                        Long value)
```
    Add a single ChildJobsInState entry
    
    See Also:
    
    withChildJobsInState(java.util.Map<java.lang.String, java.lang.Long>)
  - clearChildJobsInStateEntries
```
public DescribeBackupJobResult clearChildJobsInStateEntries()
```
    Removes all the entries added into ChildJobsInState.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 DescribeBackupJobResult 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 a backup job was initiated.
    
    Parameters:
    
    initiationDate - This is the date a backup job was initiated.
  - getInitiationDate
```
public Date getInitiationDate()
```
    This is the date a backup job was initiated.
    
    Returns:
    
    This is the date a backup job was initiated.
  - withInitiationDate
```
public DescribeBackupJobResult withInitiationDate(Date initiationDate)
```
    This is the date a backup job was initiated.
    
    Parameters:
    
    initiationDate - This is the date a 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 is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
    
    Parameters:
    
    messageCategory - This is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
  - getMessageCategory
```
public String getMessageCategory()
```
    This is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
    
    Returns:
    
    This is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
  - withMessageCategory
```
public DescribeBackupJobResult withMessageCategory(String messageCategory)
```
    This is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
    
    Parameters:
    
    messageCategory - This is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
    
    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 DescribeBackupJobResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class DescribeBackupJobResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeBackupJobResult

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

setResourceType

getResourceType

withResourceType

setBytesTransferred

getBytesTransferred

withBytesTransferred

setExpectedCompletionDate

getExpectedCompletionDate

withExpectedCompletionDate

setStartBy

getStartBy

withStartBy

getBackupOptions

setBackupOptions

withBackupOptions

addBackupOptionsEntry

clearBackupOptionsEntries

setBackupType

getBackupType

withBackupType

setParentJobId

getParentJobId

withParentJobId

setIsParent

getIsParent

withIsParent

isParent

setNumberOfChildJobs