java.lang.Object
- software.amazon.awssdk.services.backup.model.CopyJob

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CopyJob.Builder,CopyJob>

@Generated("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 Description

static interface CopyJob.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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()`
`Map<CopyJobState,Long>`	`childJobsInState()`	This returns the statistics of the included child (nested) copy jobs.
`Map<String,Long>`	`childJobsInStateAsStrings()`	This returns the statistics of the included child (nested) copy jobs.
`Instant`	`completionDate()`	The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC).
`String`	`compositeMemberIdentifier()`	This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack.
`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)`
`boolean`	`hasChildJobsInState()`	For responses, this returns true if the service returned a value for the ChildJobsInState property.
`int`	`hashCode()`
`String`	`iamRoleArn()`	Specifies the IAM role ARN used to copy the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`Boolean`	`isParent()`	This is a boolean value indicating this is a parent (composite) copy job.
`String`	`messageCategory()`	This parameter is the job count for the specified message category.
`Long`	`numberOfChildJobs()`	This is the number of child (nested) copy jobs.
`String`	`parentJobId()`	This uniquely identifies a request to Backup to copy a resource.
`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`	`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 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.
  - parentJobId
```
public final String parentJobId()
```
    This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
    
    Returns:
    
    This uniquely identifies a request to Backup to copy 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) copy job.
    
    Returns:
    
    This is a boolean value indicating this is a parent (composite) copy job.
  - compositeMemberIdentifier
```
public final String compositeMemberIdentifier()
```
    This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
    
    Returns:
    
    This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
  - numberOfChildJobs
```
public final Long numberOfChildJobs()
```
    This is the number of child (nested) copy jobs.
    
    Returns:
    
    This is the number of child (nested) copy jobs.
  - childJobsInState
```
public final Map<CopyJobState,Long> childJobsInState()
```
    This returns the statistics of the included child (nested) copy jobs.
    
    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 hasChildJobsInState() method.
    
    Returns:
    
    This returns the statistics of the included child (nested) copy jobs.
  - hasChildJobsInState
```
public final boolean hasChildJobsInState()
```
    For responses, this returns true if the service returned a value for the ChildJobsInState 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.
  - childJobsInStateAsStrings
```
public final Map<String,Long> childJobsInStateAsStrings()
```
    This returns the statistics of the included child (nested) copy jobs.
    
    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 hasChildJobsInState() method.
    
    Returns:
    
    This returns the statistics of the included child (nested) copy jobs.
  - 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.
  - messageCategory
```
public final String messageCategory()
```
    This parameter is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.
    
    The the value ANY returns count of all message categories.
    
    AGGREGATE_ALL aggregates job counts for all message categories and returns the sum
    
    Returns:
    
    This parameter is the job count for the specified message category.
    
    Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.
    
    The the value ANY returns count of all message categories.
    
    AGGREGATE_ALL aggregates job counts for all message categories and returns the sum
  - 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

Class CopyJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

accountId

copyJobId

sourceBackupVaultArn

sourceRecoveryPointArn

destinationBackupVaultArn

destinationRecoveryPointArn

resourceArn

creationDate

completionDate

state

stateAsString

statusMessage

backupSizeInBytes

iamRoleArn

createdBy

resourceType

parentJobId

isParent

compositeMemberIdentifier

numberOfChildJobs

childJobsInState

hasChildJobsInState

childJobsInStateAsStrings

resourceName

messageCategory

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields