software.amazon.awssdk.services.backup.model

Class CopyJob

java.lang.Object

software.amazon.awssdk.services.backup.model.CopyJob

All Implemented Interfaces:

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

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

Contains detailed information about a copy job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CopyJob.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The account ID that owns the copy job.
Long	backupSizeInBytes() The size, in bytes, of a copy job.
static CopyJob.Builder	builder()
Instant	completionDate() The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC).
String	copyJobId() Uniquely identifies a copy job.
RecoveryPointCreator	createdBy() Returns the value of the CreatedBy property for this object.
Instant	creationDate() The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC).
String	destinationBackupVaultArn() An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String	destinationRecoveryPointArn() An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iamRoleArn() Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
String	resourceArn() The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
String	resourceType() The type of Amazon Web Services resource to be copied; 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 CopyJob.Builder>	serializableBuilderClass()
String	sourceBackupVaultArn() An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String	sourceRecoveryPointArn() An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
CopyJobState	state() The current state of a copy job.
String	stateAsString() The current state of a copy job.
String	statusMessage() A detailed message explaining the status of the job to copy a resource.
CopyJob.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 copy job.

Returns:

The account ID that owns the copy job.

copyJobId

public final String copyJobId()

Uniquely identifies a copy job.

Returns:

Uniquely identifies a copy job.

sourceBackupVaultArn

public final String sourceBackupVaultArn()

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

Returns:

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

sourceRecoveryPointArn

public final String sourceRecoveryPointArn()

An ARN that uniquely identifies a source 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 source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

destinationBackupVaultArn

public final String destinationBackupVaultArn()

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

Returns:

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

destinationRecoveryPointArn

public final String destinationRecoveryPointArn()

An ARN that uniquely identifies a destination 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 destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

resourceArn

public final String resourceArn()

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

creationDate

public final Instant creationDate()

The date and time a copy 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 copy 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 copy 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 copy 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 CopyJobState state()

The current state of a copy job.

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

Returns:

The current state of a copy job.

See Also:

CopyJobState

stateAsString

public final String stateAsString()

The current state of a copy job.

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

Returns:

The current state of a copy job.

See Also:

CopyJobState

statusMessage

public final String statusMessage()

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

Returns:

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

backupSizeInBytes

public final Long backupSizeInBytes()

The size, in bytes, of a copy job.

Returns:

The size, in bytes, of a copy job.

iamRoleArn

public final String iamRoleArn()

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Returns:

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

createdBy

public final RecoveryPointCreator createdBy()

Returns the value of the CreatedBy property for this object.

Returns:

The value of the CreatedBy property for this object.

resourceType

public final String resourceType()

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

Returns:

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

toBuilder

public CopyJob.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CopyJob.Builder,CopyJob>

builder

public static CopyJob.Builder builder()

serializableBuilderClass

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