Class DescribeRestoreJobResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.backup.model.BackupResponse
-
- software.amazon.awssdk.services.backup.model.DescribeRestoreJobResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeRestoreJobResponse.Builder,DescribeRestoreJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeRestoreJobResponse extends BackupResponse implements ToCopyableBuilder<DescribeRestoreJobResponse.Builder,DescribeRestoreJobResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeRestoreJobResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccountId()Returns the account ID that owns the restore job.LongbackupSizeInBytes()The size, in bytes, of the restored resource.static DescribeRestoreJobResponse.Builderbuilder()InstantcompletionDate()The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC).RestoreJobCreatorcreatedBy()Contains identifying information about the creation of a restore job.StringcreatedResourceArn()An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored.InstantcreationDate()The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC).RestoreDeletionStatusdeletionStatus()This notes the status of the data generated by the restore test.StringdeletionStatusAsString()This notes the status of the data generated by the restore test.StringdeletionStatusMessage()This describes the restore job deletion status.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)LongexpectedCompletionTimeMinutes()The amount of time in minutes that a job restoring a recovery point is expected to take.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringiamRoleArn()Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access.StringpercentDone()Contains an estimated percentage that is complete of a job at the time the job status was queried.StringrecoveryPointArn()An ARN that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.InstantrecoveryPointCreationDate()This is the creation date of the recovery point made by the specifed restore job.StringresourceType()Returns metadata associated with a restore job listed by resource type.StringrestoreJobId()Uniquely identifies the job that restores a recovery point.List<SdkField<?>>sdkFields()static Class<? extends DescribeRestoreJobResponse.Builder>serializableBuilderClass()RestoreJobStatusstatus()Status code specifying the state of the job that is initiated by Backup to restore a recovery point.StringstatusAsString()Status code specifying the state of the job that is initiated by Backup to restore a recovery point.StringstatusMessage()A message showing the status of a job to restore a recovery point.DescribeRestoreJobResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.RestoreValidationStatusvalidationStatus()This is the status of validation run on the indicated restore job.StringvalidationStatusAsString()This is the status of validation run on the indicated restore job.StringvalidationStatusMessage()This describes the status of validation run on the indicated restore job.-
Methods inherited from class software.amazon.awssdk.services.backup.model.BackupResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
accountId
public final String accountId()
Returns the account ID that owns the restore job.
- Returns:
- Returns the account ID that owns the restore job.
-
restoreJobId
public final String restoreJobId()
Uniquely identifies the job that restores a recovery point.
- Returns:
- Uniquely identifies the job that restores a recovery point.
-
recoveryPointArn
public final 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.- 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.
-
creationDate
public final 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.- Returns:
- 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.
-
completionDate
public final 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.- Returns:
- 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.
-
status
public final RestoreJobStatus status()
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnRestoreJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
- See Also:
RestoreJobStatus
-
statusAsString
public final String statusAsString()
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnRestoreJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
- See Also:
RestoreJobStatus
-
statusMessage
public final String statusMessage()
A message showing the status of a job to restore a recovery point.
- Returns:
- A message showing the status of a job to restore a recovery point.
-
percentDone
public final String percentDone()
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.
-
backupSizeInBytes
public final Long backupSizeInBytes()
The size, in bytes, of the restored resource.
- Returns:
- The size, in bytes, of the restored resource.
-
iamRoleArn
public final String iamRoleArn()
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.
-
expectedCompletionTimeMinutes
public final Long expectedCompletionTimeMinutes()
The amount of time in minutes that a job restoring a recovery point is expected to take.
- Returns:
- The amount of time in minutes that a job restoring a recovery point is expected to take.
-
createdResourceArn
public final 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.
- Returns:
- 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.
-
resourceType
public final String resourceType()
Returns metadata associated with a restore job listed by resource type.
- Returns:
- Returns metadata associated with a restore job listed by resource type.
-
recoveryPointCreationDate
public final Instant recoveryPointCreationDate()
This is the creation date of the recovery point made by the specifed restore job.
- Returns:
- This is the creation date of the recovery point made by the specifed restore job.
-
createdBy
public final RestoreJobCreator createdBy()
Contains identifying information about the creation of a restore job.
- Returns:
- Contains identifying information about the creation of a restore job.
-
validationStatus
public final RestoreValidationStatus validationStatus()
This is the status of validation run on the indicated restore job.
If the service returns an enum value that is not available in the current SDK version,
validationStatuswill returnRestoreValidationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvalidationStatusAsString().- Returns:
- This is the status of validation run on the indicated restore job.
- See Also:
RestoreValidationStatus
-
validationStatusAsString
public final String validationStatusAsString()
This is the status of validation run on the indicated restore job.
If the service returns an enum value that is not available in the current SDK version,
validationStatuswill returnRestoreValidationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvalidationStatusAsString().- Returns:
- This is the status of validation run on the indicated restore job.
- See Also:
RestoreValidationStatus
-
validationStatusMessage
public final String validationStatusMessage()
This describes the status of validation run on the indicated restore job.
- Returns:
- This describes the status of validation run on the indicated restore job.
-
deletionStatus
public final RestoreDeletionStatus deletionStatus()
This notes the status of the data generated by the restore test. The status may be
Deleting,Failed, orSuccessful.If the service returns an enum value that is not available in the current SDK version,
deletionStatuswill returnRestoreDeletionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeletionStatusAsString().- Returns:
- This notes the status of the data generated by the restore test. The status may be
Deleting,Failed, orSuccessful. - See Also:
RestoreDeletionStatus
-
deletionStatusAsString
public final String deletionStatusAsString()
This notes the status of the data generated by the restore test. The status may be
Deleting,Failed, orSuccessful.If the service returns an enum value that is not available in the current SDK version,
deletionStatuswill returnRestoreDeletionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeletionStatusAsString().- Returns:
- This notes the status of the data generated by the restore test. The status may be
Deleting,Failed, orSuccessful. - See Also:
RestoreDeletionStatus
-
deletionStatusMessage
public final String deletionStatusMessage()
This describes the restore job deletion status.
- Returns:
- This describes the restore job deletion status.
-
toBuilder
public DescribeRestoreJobResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeRestoreJobResponse.Builder,DescribeRestoreJobResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeRestoreJobResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeRestoreJobResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-