software.amazon.awssdk.services.backup.model

Class BackupJob

java.lang.Object

software.amazon.awssdk.services.backup.model.BackupJob

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BackupJob.Builder,BackupJob>

@Generated(value="software.amazon.awssdk:codegen")
public final class BackupJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BackupJob.Builder,BackupJob>

Contains detailed information about a backup job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BackupJob.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The account ID that owns the backup job.
String	backupJobId() Uniquely identifies a request to Backup to back up a resource.
Map<String,String>	backupOptions() Specifies the backup option for a selected resource.
Long	backupSizeInBytes() The size, in bytes, of a backup.
String	backupType() Represents the type of backup 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 BackupJob.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 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 used to create it.
Instant	creationDate() The date and time 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 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() For responses, this returns true if the service returned a value for the BackupOptions property.
int	hashCode()
String	iamRoleArn() Specifies the IAM role ARN used to create the target recovery point.
Boolean	isParent() This is a boolean value indicating this is a parent (composite) backup job.
String	parentJobId() This uniquely identifies a request to Backup to back up a resource.
String	percentDone() Contains an estimated percentage 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 resource.
String	resourceName() This is the non-unique name of the resource that belongs to the specified backup.
String	resourceType() The type of Amazon Web Services 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 BackupJob.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 backup job.
String	stateAsString() The current state of a backup job.
String	statusMessage() A detailed message explaining the status of the job to back up a resource.
BackupJob.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

The account ID that owns the backup job.

Returns:

The account ID that owns the backup job.

backupJobId

public final String backupJobId()

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

Returns:

Uniquely identifies a request to 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 Amazon Web Services 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 Amazon Web Services 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 resource. The format of the ARN depends on the resource type.

Returns:

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

creationDate

public final Instant creationDate()

The date and time 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 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 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 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 backup job.

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

See Also:

BackupJobState

stateAsString

public final String stateAsString()

The current state of a backup job.

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

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 complete of a job at the time the job status was queried.

Returns:

Contains an estimated percentage 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. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

Returns:

Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

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 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 used to create it.

expectedCompletionDate

public final Instant expectedCompletionDate()

The date and time 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 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.

resourceType

public final String resourceType()

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

Returns:

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

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.

hasBackupOptions

public final boolean hasBackupOptions()

For responses, this returns true if the service returned a value for the BackupOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

backupOptions

public final Map<String,String> backupOptions()

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBackupOptions() method.

Returns:

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

backupType

public final String backupType()

Represents the type of backup for a backup job.

Returns:

Represents the type of backup for a backup job.

parentJobId

public final String parentJobId()

This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

Returns:

This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

isParent

public final Boolean isParent()

This is a boolean value indicating this is a parent (composite) backup job.

Returns:

This is a boolean value indicating this is a parent (composite) backup job.

resourceName

public final String resourceName()

This is the non-unique name of the resource that belongs to the specified backup.

Returns:

This is the non-unique name of the resource that belongs to the specified backup.

toBuilder

public BackupJob.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BackupJob.Builder,BackupJob>

builder

public static BackupJob.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo