java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.fsx.model.FSxRequest
    - - software.amazon.awssdk.services.fsx.model.CopyBackupRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CopyBackupRequest.Builder,CopyBackupRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CopyBackupRequest
extends FSxRequest
implements ToCopyableBuilder<CopyBackupRequest.Builder,CopyBackupRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CopyBackupRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CopyBackupRequest.Builder`	`builder()`
`String`	`clientRequestToken()`	Returns the value of the ClientRequestToken property for this object.
`Boolean`	`copyTags()`	A Boolean flag indicating whether tags from the source backup should be copied to the backup copy.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyId()`	Returns the value of the KmsKeyId property for this object.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CopyBackupRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceBackupId()`	The ID of the source backup.
`String`	`sourceRegion()`	The source Amazon Web Services Region of the backup.
`List<Tag>`	`tags()`	Returns the value of the Tags property for this object.
`CopyBackupRequest.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
  - clientRequestToken
```
public final String clientRequestToken()
```
    Returns the value of the ClientRequestToken property for this object.
    
    Returns:
    
    The value of the ClientRequestToken property for this object.
  - sourceBackupId
```
public final String sourceBackupId()
```
    The ID of the source backup. Specifies the ID of the backup that's being copied.
    
    Returns:
    
    The ID of the source backup. Specifies the ID of the backup that's being copied.
  - sourceRegion
```
public final String sourceRegion()
```
    The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).
    
    Returns:
    
    The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).
  - kmsKeyId
```
public final String kmsKeyId()
```
    Returns the value of the KmsKeyId property for this object.
    
    Returns:
    
    The value of the KmsKeyId property for this object.
  - copyTags
```
public final Boolean copyTags()
```
    A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.
    
    If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.
    
    Returns:
    
    A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.
    
    If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    Returns the value of the Tags property for this object.
    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 hasTags() method.
    
    Returns:
    
    The value of the Tags property for this object.
  - toBuilder
```
public CopyBackupRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CopyBackupRequest.Builder,CopyBackupRequest>
    
    Specified by:
    
    toBuilder in class FSxRequest
  - builder
```
public static CopyBackupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CopyBackupRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CopyBackupRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

clientRequestToken

sourceBackupId

sourceRegion

kmsKeyId

copyTags

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField