S3CopyObjectOperation (AWS Java SDK :: Services :: Amazon S3 Control 2.11.6 API)

java.lang.Object
- software.amazon.awssdk.services.s3control.model.S3CopyObjectOperation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class S3CopyObjectOperation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>
```
Contains the configuration parameters for a PUT Copy object operation. Amazon S3 batch operations passes each value through to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface S3CopyObjectOperation.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`S3CopyObjectOperation.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<S3Grant>`	`accessControlGrants()`
`static S3CopyObjectOperation.Builder`	`builder()`
`S3CannedAccessControlList`	`cannedAccessControlList()`
`String`	`cannedAccessControlListAsString()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccessControlGrants()` Returns true if the AccessControlGrants property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasNewObjectTagging()` Returns true if the NewObjectTagging property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`S3MetadataDirective`	`metadataDirective()`
`String`	`metadataDirectiveAsString()`
`Instant`	`modifiedSinceConstraint()`
`S3ObjectMetadata`	`newObjectMetadata()`
`List<S3Tag>`	`newObjectTagging()`
`S3ObjectLockLegalHoldStatus`	`objectLockLegalHoldStatus()`
`String`	`objectLockLegalHoldStatusAsString()`
`S3ObjectLockMode`	`objectLockMode()`
`String`	`objectLockModeAsString()`
`Instant`	`objectLockRetainUntilDate()`
`String`	`redirectLocation()`
`Boolean`	`requesterPays()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends S3CopyObjectOperation.Builder>`	`serializableBuilderClass()`
`String`	`sseAwsKmsKeyId()`
`S3StorageClass`	`storageClass()`
`String`	`storageClassAsString()`
`String`	`targetKeyPrefix()`
`String`	`targetResource()`
`S3CopyObjectOperation.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`unModifiedSinceConstraint()`

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
  - targetResource
```
public String targetResource()
```
    Returns:
  - cannedAccessControlList
```
public S3CannedAccessControlList cannedAccessControlList()
```
    If the service returns an enum value that is not available in the current SDK version, cannedAccessControlList will return S3CannedAccessControlList.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedAccessControlListAsString().
    
    Returns:
    
    See Also:
    
    S3CannedAccessControlList
  - cannedAccessControlListAsString
```
public String cannedAccessControlListAsString()
```
    If the service returns an enum value that is not available in the current SDK version, cannedAccessControlList will return S3CannedAccessControlList.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedAccessControlListAsString().
    
    Returns:
    
    See Also:
    
    S3CannedAccessControlList
  - hasAccessControlGrants
```
public boolean hasAccessControlGrants()
```
    Returns true if the AccessControlGrants property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - accessControlGrants
```
public List<S3Grant> accessControlGrants()
```
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAccessControlGrants() to see if a value was sent in this field.
    
    Returns:
  - metadataDirective
```
public S3MetadataDirective metadataDirective()
```
    If the service returns an enum value that is not available in the current SDK version, metadataDirective will return S3MetadataDirective.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metadataDirectiveAsString().
    
    Returns:
    
    See Also:
    
    S3MetadataDirective
  - metadataDirectiveAsString
```
public String metadataDirectiveAsString()
```
    If the service returns an enum value that is not available in the current SDK version, metadataDirective will return S3MetadataDirective.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metadataDirectiveAsString().
    
    Returns:
    
    See Also:
    
    S3MetadataDirective
  - modifiedSinceConstraint
```
public Instant modifiedSinceConstraint()
```
    Returns:
  - newObjectMetadata
```
public S3ObjectMetadata newObjectMetadata()
```
    Returns:
  - hasNewObjectTagging
```
public boolean hasNewObjectTagging()
```
    Returns true if the NewObjectTagging property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - newObjectTagging
```
public List<S3Tag> newObjectTagging()
```
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNewObjectTagging() to see if a value was sent in this field.
    
    Returns:
  - redirectLocation
```
public String redirectLocation()
```
    Returns:
  - requesterPays
```
public Boolean requesterPays()
```
    Returns:
  - storageClass
```
public S3StorageClass storageClass()
```
    If the service returns an enum value that is not available in the current SDK version, storageClass will return S3StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    See Also:
    
    S3StorageClass
  - storageClassAsString
```
public String storageClassAsString()
```
    If the service returns an enum value that is not available in the current SDK version, storageClass will return S3StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    See Also:
    
    S3StorageClass
  - unModifiedSinceConstraint
```
public Instant unModifiedSinceConstraint()
```
    Returns:
  - sseAwsKmsKeyId
```
public String sseAwsKmsKeyId()
```
    Returns:
  - targetKeyPrefix
```
public String targetKeyPrefix()
```
    Returns:
  - objectLockLegalHoldStatus
```
public S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
```
    If the service returns an enum value that is not available in the current SDK version, objectLockLegalHoldStatus will return S3ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockLegalHoldStatusAsString().
    
    Returns:
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - objectLockLegalHoldStatusAsString
```
public String objectLockLegalHoldStatusAsString()
```
    If the service returns an enum value that is not available in the current SDK version, objectLockLegalHoldStatus will return S3ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockLegalHoldStatusAsString().
    
    Returns:
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - objectLockMode
```
public S3ObjectLockMode objectLockMode()
```
    If the service returns an enum value that is not available in the current SDK version, objectLockMode will return S3ObjectLockMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockModeAsString().
    
    Returns:
    
    See Also:
    
    S3ObjectLockMode
  - objectLockModeAsString
```
public String objectLockModeAsString()
```
    If the service returns an enum value that is not available in the current SDK version, objectLockMode will return S3ObjectLockMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockModeAsString().
    
    Returns:
    
    See Also:
    
    S3ObjectLockMode
  - objectLockRetainUntilDate
```
public Instant objectLockRetainUntilDate()
```
    Returns:
  - toBuilder
```
public S3CopyObjectOperation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>
  - builder
```
public static S3CopyObjectOperation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends S3CopyObjectOperation.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class S3CopyObjectOperation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

targetResource

cannedAccessControlList

cannedAccessControlListAsString

hasAccessControlGrants

accessControlGrants

metadataDirective

metadataDirectiveAsString

modifiedSinceConstraint

newObjectMetadata

hasNewObjectTagging

newObjectTagging

redirectLocation

requesterPays

storageClass

storageClassAsString

unModifiedSinceConstraint

sseAwsKmsKeyId

targetKeyPrefix

objectLockLegalHoldStatus

objectLockLegalHoldStatusAsString

objectLockMode

objectLockModeAsString

objectLockRetainUntilDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields