software.amazon.awssdk.services.backup.model

Class StartCopyJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.backup.model.BackupRequest

software.amazon.awssdk.services.backup.model.StartCopyJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartCopyJobRequest.Builder,StartCopyJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartCopyJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartCopyJobRequest.Builder	builder()
String	destinationBackupVaultArn() An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
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	idempotencyToken() A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob.
Lifecycle	lifecycle() Returns the value of the Lifecycle property for this object.
String	recoveryPointArn() An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
List<SdkField<?>>	sdkFields()
static Class<? extends StartCopyJobRequest.Builder>	serializableBuilderClass()
String	sourceBackupVaultName() The name of a logical source container where backups are stored.
StartCopyJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

recoveryPointArn

public final String recoveryPointArn()

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

sourceBackupVaultName

public final String sourceBackupVaultName()

The name of a logical source 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 source 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.

destinationBackupVaultArn

public final String destinationBackupVaultArn()

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

Returns:

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

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.

idempotencyToken

public final String idempotencyToken()

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Returns:

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

lifecycle

public final Lifecycle lifecycle()

Returns the value of the Lifecycle property for this object.

Returns:

The value of the Lifecycle property for this object.

toBuilder

public StartCopyJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartCopyJobRequest.Builder,StartCopyJobRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static StartCopyJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo