software.amazon.awssdk.services.backup.model

Class DescribeBackupJobResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeBackupJobResponse.Builder,DescribeBackupJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeBackupJobResponse
extends BackupResponse
implements ToCopyableBuilder<DescribeBackupJobResponse.Builder,DescribeBackupJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeBackupJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() Returns the account ID that owns the backup job.
String	backupJobId() Uniquely identifies a request to AWS Backup to back up a resource.
Map<String,String>	backupOptions() Represents the options specified as part of backup plan or on-demand backup job.
Long	backupSizeInBytes() The size, in bytes, of a backup.
String	backupType() Represents the actual backup type selected for a backup job.
String	backupVaultArn() An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String	backupVaultName() The name of a logical container where backups are stored.
static DescribeBackupJobResponse.Builder	builder()
Long	bytesTransferred() The size in bytes transferred to a backup vault at the time that the job status was queried.
Instant	completionDate() The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC).
RecoveryPointCreator	createdBy() Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
Instant	creationDate() The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupOptions() Returns true if the BackupOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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	resourceArn() An ARN that uniquely identifies a saved resource.
String	resourceType() The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeBackupJobResponse.Builder>	serializableBuilderClass()
Instant	startBy() Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled.
BackupJobState	state() The current state of a resource recovery point.
String	stateAsString() The current state of a resource recovery point.
String	statusMessage() A detailed message explaining the status of the job to back up a resource.
DescribeBackupJobResponse.Builder	toBuilder()
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

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 backup job.

Returns:

Returns the account ID that owns the backup job.

backupJobId

public final String backupJobId()

Uniquely identifies a request to AWS Backup to back up a resource.

Returns:

Uniquely identifies a request to AWS Backup to back up a resource.

backupVaultName

public final String 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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

backupVaultArn

public final String backupVaultArn()

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Returns:

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

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.

resourceArn

public final String resourceArn()

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

Returns:

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

creationDate

public final Instant 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.

Returns:

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.

completionDate

public final Instant 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.

Returns:

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.

state

public final BackupJobState state()

The current state of a resource recovery point.

If the service returns an enum value that is not available in the current SDK version, state will return BackupJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state of a resource recovery point.

See Also:

BackupJobState

stateAsString

public final String stateAsString()

The current state of a resource recovery point.

If the service returns an enum value that is not available in the current SDK version, state will return BackupJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The current state of a resource recovery point.

See Also:

BackupJobState

statusMessage

public final String statusMessage()

A detailed message explaining the status of the job to back up a resource.

Returns:

A detailed message explaining the status of the job to back up a resource.

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 a backup.

Returns:

The size, in bytes, of a backup.

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.

createdBy

public final RecoveryPointCreator createdBy()

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

Returns:

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

resourceType

public final String resourceType()

The type of AWS 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:

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

bytesTransferred

public final Long bytesTransferred()

The size in bytes transferred to a backup vault at the time that the job status was queried.

Returns:

The size in bytes transferred to a backup vault at the time that the job status was queried.

expectedCompletionDate

public final 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). The value of ExpectedCompletionDate 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 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.

startBy

public final Instant 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 of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

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 of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

hasBackupOptions

public final boolean hasBackupOptions()

Returns true if the BackupOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

backupOptions

public final Map<String,String> backupOptions()

Represents the options specified as part of backup plan or on-demand backup job.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasBackupOptions() to see if a value was sent in this field.

Returns:

Represents the options specified as part of backup plan or on-demand backup job.

backupType

public final String backupType()

Represents the actual backup type selected for a backup job. For example, if a successful WindowsVSS backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type that was is a regular backup.

Returns:

Represents the actual backup type selected for a backup job. For example, if a successful WindowsVSS backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type that was is a regular backup.

toBuilder

public DescribeBackupJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeBackupJobResponse.Builder,DescribeBackupJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeBackupJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeBackupJobResponse.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo