Interface DescribeBackupJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,BackupResponse.Builder
,Buildable
,CopyableBuilder<DescribeBackupJobResponse.Builder,
,DescribeBackupJobResponse> SdkBuilder<DescribeBackupJobResponse.Builder,
,DescribeBackupJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeBackupJobResponse
-
Method Summary
Modifier and TypeMethodDescriptionReturns the account ID that owns the backup job.backupJobId
(String backupJobId) Uniquely identifies a request to Backup to back up a resource.backupOptions
(Map<String, String> backupOptions) Represents the options specified as part of backup plan or on-demand backup job.backupSizeInBytes
(Long backupSizeInBytes) The size, in bytes, of a backup.backupType
(String backupType) Represents the actual backup type selected for a backup job.backupVaultArn
(String backupVaultArn) An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.backupVaultName
(String backupVaultName) The name of a logical container where backups are stored.bytesTransferred
(Long bytesTransferred) The size in bytes transferred to a backup vault at the time that the job status was queried.childJobsInState
(Map<BackupJobState, Long> childJobsInState) This returns the statistics of the included child (nested) backup jobs.childJobsInStateWithStrings
(Map<String, Long> childJobsInState) This returns the statistics of the included child (nested) backup jobs.completionDate
(Instant completionDate) The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).createdBy
(Consumer<RecoveryPointCreator.Builder> createdBy) Contains identifying information about the creation of a backup job, including theBackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan that is used to create it.createdBy
(RecoveryPointCreator createdBy) Contains identifying information about the creation of a backup job, including theBackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan that is used to create it.creationDate
(Instant creationDate) The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC).expectedCompletionDate
(Instant 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).iamRoleArn
(String iamRoleArn) Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access
.initiationDate
(Instant initiationDate) This is the date a backup job was initiated.This returns the boolean value that a backup job is a parent (composite) job.messageCategory
(String messageCategory) This is the job count for the specified message category.numberOfChildJobs
(Long numberOfChildJobs) This returns the number of child (nested) backup jobs.parentJobId
(String parentJobId) This returns the parent (composite) resource backup job ID.percentDone
(String percentDone) Contains an estimated percentage that is complete of a job at the time the job status was queried.recoveryPointArn
(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
.resourceArn
(String resourceArn) An ARN that uniquely identifies a saved resource.resourceName
(String resourceName) This is the non-unique name of the resource that belongs to the specified backup.resourceType
(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.Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled.The current state of a backup job.state
(BackupJobState state) The current state of a backup job.statusMessage
(String statusMessage) A detailed message explaining the status of the job to back up a resource.Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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 ofCreationDate
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.
-
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 ofCompletionDate
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.
-
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:
-
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:
-
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.
-
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.
-
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.
-
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.
-
createdBy
Contains identifying information about the creation of a backup job, including the
BackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan that is used to create it.- Parameters:
createdBy
- Contains identifying information about the creation of a backup job, including theBackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
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.
-
createdBy
default DescribeBackupJobResponse.Builder createdBy(Consumer<RecoveryPointCreator.Builder> createdBy) Contains identifying information about the creation of a backup job, including the
This is a convenience method that creates an instance of theBackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan that is used to create it.RecoveryPointCreator.Builder
avoiding the need to create one manually viaRecoveryPointCreator.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocreatedBy(RecoveryPointCreator)
.- Parameters:
createdBy
- a consumer that will call methods onRecoveryPointCreator.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
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 ofExpectedCompletionDate
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.
-
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 ofStartBy
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, theStartBy
time would be 8:00 PM on the date specified. The value ofStartBy
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.
-
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.
-
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"
. IfBackupType
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"
. IfBackupType
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.
-
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.
-
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.
-
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.
-
childJobsInStateWithStrings
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.
-
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.
-
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.
-
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.
-
messageCategory
This is the job count for the specified message category.
Example strings may include
AccessDenied
,SUCCESS
,AGGREGATE_ALL
, andINVALIDPARAMETERS
. 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
, andINVALIDPARAMETERS
. View Monitoring for a list of accepted MessageCategory strings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-