Class DescribeRestoreJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeRestoreJobResponse.Builder,
DescribeRestoreJobResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
Returns the account ID that owns the restore job.final Long
The size, in bytes, of the restored resource.builder()
final Instant
The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC).final RestoreJobCreator
Contains identifying information about the creation of a restore job.final String
The Amazon Resource Name (ARN) of the resource that was created by the restore job.final Instant
The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC).final RestoreDeletionStatus
The status of the data generated by the restore test.final String
The status of the data generated by the restore test.final String
This describes the restore job deletion status.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
The amount of time in minutes that a job restoring a recovery point is expected to take.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access
.final String
Contains an estimated percentage that is complete of a job at the time the job status was queried.final String
An ARN that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.final Instant
The creation date of the recovery point made by the specifed restore job.final String
Returns metadata associated with a restore job listed by resource type.final String
Uniquely identifies the job that restores a recovery point.static Class
<? extends DescribeRestoreJobResponse.Builder> final RestoreJobStatus
status()
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.final String
Status code specifying the state of the job that is initiated by Backup to restore a recovery point.final String
A message showing the status of a job to restore a recovery point.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final RestoreValidationStatus
The status of validation run on the indicated restore job.final String
The status of validation run on the indicated restore job.final String
The status message.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accountId
Returns the account ID that owns the restore job.
- Returns:
- Returns the account ID that owns the restore job.
-
restoreJobId
Uniquely identifies the job that restores a recovery point.
- Returns:
- Uniquely identifies the job that restores a recovery point.
-
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
The date and time that a restore 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 restore 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.
-
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
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 restore a recovery point 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.
-
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,
status
will 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:
-
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,
status
will 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:
-
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
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
The size, in bytes, of the restored resource.
- Returns:
- The size, in bytes, of the restored resource.
-
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
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
The Amazon Resource Name (ARN) of the resource that was created by the restore job.
The format of the ARN depends on the resource type of the backed-up resource.
- Returns:
- The Amazon Resource Name (ARN) of the resource that was created by the restore job.
The format of the ARN depends on the resource type of the backed-up resource.
-
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
The creation date of the recovery point made by the specifed restore job.
- Returns:
- The creation date of the recovery point made by the specifed restore job.
-
createdBy
Contains identifying information about the creation of a restore job.
- Returns:
- Contains identifying information about the creation of a restore job.
-
validationStatus
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,
validationStatus
will returnRestoreValidationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvalidationStatusAsString()
.- Returns:
- The status of validation run on the indicated restore job.
- See Also:
-
validationStatusAsString
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,
validationStatus
will returnRestoreValidationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvalidationStatusAsString()
.- Returns:
- The status of validation run on the indicated restore job.
- See Also:
-
validationStatusMessage
-
deletionStatus
The status of the data generated by the restore test.
If the service returns an enum value that is not available in the current SDK version,
deletionStatus
will returnRestoreDeletionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeletionStatusAsString()
.- Returns:
- The status of the data generated by the restore test.
- See Also:
-
deletionStatusAsString
The status of the data generated by the restore test.
If the service returns an enum value that is not available in the current SDK version,
deletionStatus
will returnRestoreDeletionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeletionStatusAsString()
.- Returns:
- The status of the data generated by the restore test.
- See Also:
-
deletionStatusMessage
This describes the restore job deletion status.
- Returns:
- This describes the restore job deletion status.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeRestoreJobResponse.Builder,
DescribeRestoreJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-