software.amazon.awssdk.services.backup.model

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(value="software.amazon.awssdk:codegen")
public final class DescribeRestoreJobResponse
extends BackupResponse
implements ToCopyableBuilder<DescribeRestoreJobResponse.Builder,DescribeRestoreJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeRestoreJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() Returns the account ID that owns the restore job.
Long	backupSizeInBytes() The size, in bytes, of the restored resource.
static DescribeRestoreJobResponse.Builder	builder()
Instant	completionDate() The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC).
String	createdResourceArn() An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored.
Instant	creationDate() The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Long	expectedCompletionTimeMinutes() 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) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	iamRoleArn() Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
String	percentDone() Contains an estimated percentage that is complete of a job at the time the job status was queried.
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.
String	resourceType() Returns metadata associated with a restore job listed by resource type.
String	restoreJobId() Uniquely identifies the job that restores a recovery point.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeRestoreJobResponse.Builder>	serializableBuilderClass()
RestoreJobStatus	status() Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
String	statusAsString() Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
String	statusMessage() A message showing the status of a job to restore a recovery point.
DescribeRestoreJobResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

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 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

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 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

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, status will return RestoreJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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, status will return RestoreJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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.

toBuilder

public DescribeRestoreJobResponse.Builder 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 interface ToCopyableBuilder<DescribeRestoreJobResponse.Builder,DescribeRestoreJobResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeRestoreJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeRestoreJobResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.