Interface DescribeRestoreJobResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,BackupResponse.Builder,Buildable,CopyableBuilder<DescribeRestoreJobResponse.Builder,DescribeRestoreJobResponse>,SdkBuilder<DescribeRestoreJobResponse.Builder,DescribeRestoreJobResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribeRestoreJobResponse
public static interface DescribeRestoreJobResponse.Builder extends BackupResponse.Builder, SdkPojo, CopyableBuilder<DescribeRestoreJobResponse.Builder,DescribeRestoreJobResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribeRestoreJobResponse.BuilderaccountId(String accountId)Returns the account ID that owns the restore job.DescribeRestoreJobResponse.BuilderbackupSizeInBytes(Long backupSizeInBytes)The size, in bytes, of the restored resource.DescribeRestoreJobResponse.BuildercompletionDate(Instant completionDate)The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC).default DescribeRestoreJobResponse.BuildercreatedBy(Consumer<RestoreJobCreator.Builder> createdBy)Contains identifying information about the creation of a restore job.DescribeRestoreJobResponse.BuildercreatedBy(RestoreJobCreator createdBy)Contains identifying information about the creation of a restore job.DescribeRestoreJobResponse.BuildercreatedResourceArn(String createdResourceArn)An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored.DescribeRestoreJobResponse.BuildercreationDate(Instant creationDate)The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC).DescribeRestoreJobResponse.BuilderdeletionStatus(String deletionStatus)This notes the status of the data generated by the restore test.DescribeRestoreJobResponse.BuilderdeletionStatus(RestoreDeletionStatus deletionStatus)This notes the status of the data generated by the restore test.DescribeRestoreJobResponse.BuilderdeletionStatusMessage(String deletionStatusMessage)This describes the restore job deletion status.DescribeRestoreJobResponse.BuilderexpectedCompletionTimeMinutes(Long expectedCompletionTimeMinutes)The amount of time in minutes that a job restoring a recovery point is expected to take.DescribeRestoreJobResponse.BuilderiamRoleArn(String iamRoleArn)Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.DescribeRestoreJobResponse.BuilderpercentDone(String percentDone)Contains an estimated percentage that is complete of a job at the time the job status was queried.DescribeRestoreJobResponse.BuilderrecoveryPointArn(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.DescribeRestoreJobResponse.BuilderrecoveryPointCreationDate(Instant recoveryPointCreationDate)This is the creation date of the recovery point made by the specifed restore job.DescribeRestoreJobResponse.BuilderresourceType(String resourceType)Returns metadata associated with a restore job listed by resource type.DescribeRestoreJobResponse.BuilderrestoreJobId(String restoreJobId)Uniquely identifies the job that restores a recovery point.DescribeRestoreJobResponse.Builderstatus(String status)Status code specifying the state of the job that is initiated by Backup to restore a recovery point.DescribeRestoreJobResponse.Builderstatus(RestoreJobStatus status)Status code specifying the state of the job that is initiated by Backup to restore a recovery point.DescribeRestoreJobResponse.BuilderstatusMessage(String statusMessage)A message showing the status of a job to restore a recovery point.DescribeRestoreJobResponse.BuildervalidationStatus(String validationStatus)This is the status of validation run on the indicated restore job.DescribeRestoreJobResponse.BuildervalidationStatus(RestoreValidationStatus validationStatus)This is the status of validation run on the indicated restore job.DescribeRestoreJobResponse.BuildervalidationStatusMessage(String validationStatusMessage)This describes the status of validation run on the indicated restore job.-
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 Detail
-
accountId
DescribeRestoreJobResponse.Builder accountId(String accountId)
Returns the account ID that owns the restore job.
- Parameters:
accountId- Returns the account ID that owns the restore job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restoreJobId
DescribeRestoreJobResponse.Builder restoreJobId(String restoreJobId)
Uniquely identifies the job that restores a recovery point.
- Parameters:
restoreJobId- Uniquely identifies the job that restores a recovery point.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recoveryPointArn
DescribeRestoreJobResponse.Builder 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.- 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.
-
creationDate
DescribeRestoreJobResponse.Builder creationDate(Instant creationDate)
The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDateis 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 restore job is created, in Unix format and Coordinated Universal Time (UTC). The value ofCreationDateis 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
DescribeRestoreJobResponse.Builder completionDate(Instant completionDate)
The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of
CompletionDateis 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 restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value ofCompletionDateis 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.
-
status
DescribeRestoreJobResponse.Builder status(String status)
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
- Parameters:
status- Status code specifying the state of the job that is initiated by Backup to restore a recovery point.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RestoreJobStatus,RestoreJobStatus
-
status
DescribeRestoreJobResponse.Builder status(RestoreJobStatus status)
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
- Parameters:
status- Status code specifying the state of the job that is initiated by Backup to restore a recovery point.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RestoreJobStatus,RestoreJobStatus
-
statusMessage
DescribeRestoreJobResponse.Builder statusMessage(String statusMessage)
A message showing the status of a job to restore a recovery point.
- Parameters:
statusMessage- A message showing the status of a job to restore a recovery point.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
percentDone
DescribeRestoreJobResponse.Builder percentDone(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.
-
backupSizeInBytes
DescribeRestoreJobResponse.Builder backupSizeInBytes(Long backupSizeInBytes)
The size, in bytes, of the restored resource.
- Parameters:
backupSizeInBytes- The size, in bytes, of the restored resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamRoleArn
DescribeRestoreJobResponse.Builder iamRoleArn(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.
-
expectedCompletionTimeMinutes
DescribeRestoreJobResponse.Builder expectedCompletionTimeMinutes(Long expectedCompletionTimeMinutes)
The amount of time in minutes that a job restoring a recovery point is expected to take.
- Parameters:
expectedCompletionTimeMinutes- The amount of time in minutes that a job restoring a recovery point is expected to take.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdResourceArn
DescribeRestoreJobResponse.Builder createdResourceArn(String createdResourceArn)
An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
- Parameters:
createdResourceArn- An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceType
DescribeRestoreJobResponse.Builder resourceType(String resourceType)
Returns metadata associated with a restore job listed by resource type.
- Parameters:
resourceType- Returns metadata associated with a restore job listed by resource type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recoveryPointCreationDate
DescribeRestoreJobResponse.Builder recoveryPointCreationDate(Instant recoveryPointCreationDate)
This is the creation date of the recovery point made by the specifed restore job.
- Parameters:
recoveryPointCreationDate- This is the creation date of the recovery point made by the specifed restore job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdBy
DescribeRestoreJobResponse.Builder createdBy(RestoreJobCreator createdBy)
Contains identifying information about the creation of a restore job.
- Parameters:
createdBy- Contains identifying information about the creation of a restore job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdBy
default DescribeRestoreJobResponse.Builder createdBy(Consumer<RestoreJobCreator.Builder> createdBy)
Contains identifying information about the creation of a restore job.
This is a convenience method that creates an instance of theRestoreJobCreator.Builderavoiding the need to create one manually viaRestoreJobCreator.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocreatedBy(RestoreJobCreator).- Parameters:
createdBy- a consumer that will call methods onRestoreJobCreator.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
createdBy(RestoreJobCreator)
-
validationStatus
DescribeRestoreJobResponse.Builder validationStatus(String validationStatus)
This is the status of validation run on the indicated restore job.
- Parameters:
validationStatus- This is the status of validation run on the indicated restore job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RestoreValidationStatus,RestoreValidationStatus
-
validationStatus
DescribeRestoreJobResponse.Builder validationStatus(RestoreValidationStatus validationStatus)
This is the status of validation run on the indicated restore job.
- Parameters:
validationStatus- This is the status of validation run on the indicated restore job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RestoreValidationStatus,RestoreValidationStatus
-
validationStatusMessage
DescribeRestoreJobResponse.Builder validationStatusMessage(String validationStatusMessage)
This describes the status of validation run on the indicated restore job.
- Parameters:
validationStatusMessage- This describes the status of validation run on the indicated restore job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deletionStatus
DescribeRestoreJobResponse.Builder deletionStatus(String deletionStatus)
This notes the status of the data generated by the restore test. The status may be
Deleting,Failed, orSuccessful.- Parameters:
deletionStatus- This notes the status of the data generated by the restore test. The status may beDeleting,Failed, orSuccessful.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RestoreDeletionStatus,RestoreDeletionStatus
-
deletionStatus
DescribeRestoreJobResponse.Builder deletionStatus(RestoreDeletionStatus deletionStatus)
This notes the status of the data generated by the restore test. The status may be
Deleting,Failed, orSuccessful.- Parameters:
deletionStatus- This notes the status of the data generated by the restore test. The status may beDeleting,Failed, orSuccessful.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RestoreDeletionStatus,RestoreDeletionStatus
-
deletionStatusMessage
DescribeRestoreJobResponse.Builder deletionStatusMessage(String deletionStatusMessage)
This describes the restore job deletion status.
- Parameters:
deletionStatusMessage- This describes the restore job deletion status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-