PutObjectRequest (AWS Java SDK :: Services :: Amazon S3 2.0.0-preview-7 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.core.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.PutObjectRequest

All Implemented Interfaces:: software.amazon.awssdk.utils.builder.ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class PutObjectRequest
extends S3Request
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutObjectRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectCannedACL`	`acl()` The canned ACL to apply to the object.
`String`	`aclString()` The canned ACL to apply to the object.
`String`	`bucket()` Name of the bucket to which the PUT operation was initiated.
`static PutObjectRequest.Builder`	`builder()`
`String`	`cacheControl()` Specifies caching behavior along the request/reply chain.
`String`	`contentDisposition()` Specifies presentational information for the object.
`String`	`contentEncoding()` Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
`String`	`contentLanguage()` The language the content is in.
`Long`	`contentLength()` Size of the body in bytes.
`String`	`contentMD5()` The base64-encoded 128-bit MD5 digest of the part data.
`String`	`contentType()` A standard MIME type describing the format of the object data.
`boolean`	`equals(Object obj)`
`Instant`	`expires()` The date and time at which the object is no longer cacheable.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`grantFullControl()` Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
`String`	`grantRead()` Allows grantee to read the object data and its metadata.
`String`	`grantReadACP()` Allows grantee to read the object ACL.
`String`	`grantWriteACP()` Allows grantee to write the ACL for the applicable object.
`int`	`hashCode()`
`String`	`key()` Object key for which the PUT operation was initiated.
`Map<String,String>`	`metadata()` A map of metadata to store with the object in S3.
`RequestPayer`	`requestPayer()` Returns the value of the RequestPayer property for this object.
`String`	`requestPayerString()` Returns the value of the RequestPayer property for this object.
`static Class<? extends PutObjectRequest.Builder>`	`serializableBuilderClass()`
`ServerSideEncryption`	`serverSideEncryption()` The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
`String`	`serverSideEncryptionString()` The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
`String`	`sseCustomerAlgorithm()` Specifies the algorithm to use to when encrypting the object (e.g., AES256).
`String`	`sseCustomerKey()` Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
`String`	`sseCustomerKeyMD5()` Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
`String`	`ssekmsKeyId()` Specifies the AWS KMS key ID to use for object encryption.
`StorageClass`	`storageClass()` The type of storage to use for the object.
`String`	`storageClassString()` The type of storage to use for the object.
`String`	`tagging()` The tag-set for the object.
`PutObjectRequest.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`websiteRedirectLocation()` If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.

Methods inherited from class software.amazon.awssdk.core.AwsRequest
requestOverrideConfig

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
  - acl
```
public ObjectCannedACL acl()
```
    The canned ACL to apply to the object.
    If the service returns an enum value that is not available in the current SDK version, acl will return ObjectCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclString().
    
    Returns:
    
    The canned ACL to apply to the object.
    
    See Also:
    
    ObjectCannedACL
  - aclString
```
public String aclString()
```
    The canned ACL to apply to the object.
    If the service returns an enum value that is not available in the current SDK version, acl will return ObjectCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclString().
    
    Returns:
    
    The canned ACL to apply to the object.
    
    See Also:
    
    ObjectCannedACL
  - bucket
```
public String bucket()
```
    Name of the bucket to which the PUT operation was initiated.
    
    Returns:
    
    Name of the bucket to which the PUT operation was initiated.
  - cacheControl
```
public String cacheControl()
```
    Specifies caching behavior along the request/reply chain.
    
    Returns:
    
    Specifies caching behavior along the request/reply chain.
  - contentDisposition
```
public String contentDisposition()
```
    Specifies presentational information for the object.
    
    Returns:
    
    Specifies presentational information for the object.
  - contentEncoding
```
public String contentEncoding()
```
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
    
    Returns:
    
    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
  - contentLanguage
```
public String contentLanguage()
```
    The language the content is in.
    
    Returns:
    
    The language the content is in.
  - contentLength
```
public Long contentLength()
```
    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
    
    Returns:
    
    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
  - contentMD5
```
public String contentMD5()
```
    The base64-encoded 128-bit MD5 digest of the part data.
    
    Returns:
    
    The base64-encoded 128-bit MD5 digest of the part data.
  - contentType
```
public String contentType()
```
    A standard MIME type describing the format of the object data.
    
    Returns:
    
    A standard MIME type describing the format of the object data.
  - expires
```
public Instant expires()
```
    The date and time at which the object is no longer cacheable.
    
    Returns:
    
    The date and time at which the object is no longer cacheable.
  - grantFullControl
```
public String grantFullControl()
```
    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
    
    Returns:
    
    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
  - grantRead
```
public String grantRead()
```
    Allows grantee to read the object data and its metadata.
    
    Returns:
    
    Allows grantee to read the object data and its metadata.
  - grantReadACP
```
public String grantReadACP()
```
    Allows grantee to read the object ACL.
    
    Returns:
    
    Allows grantee to read the object ACL.
  - grantWriteACP
```
public String grantWriteACP()
```
    Allows grantee to write the ACL for the applicable object.
    
    Returns:
    
    Allows grantee to write the ACL for the applicable object.
  - key
```
public String key()
```
    Object key for which the PUT operation was initiated.
    
    Returns:
    
    Object key for which the PUT operation was initiated.
  - metadata
```
public Map<String,String> metadata()
```
    A map of metadata to store with the object in S3.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A map of metadata to store with the object in S3.
  - serverSideEncryption
```
public ServerSideEncryption serverSideEncryption()
```
    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
    If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionString().
    
    Returns:
    
    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
    
    See Also:
    
    ServerSideEncryption
  - serverSideEncryptionString
```
public String serverSideEncryptionString()
```
    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
    If the service returns an enum value that is not available in the current SDK version, serverSideEncryption will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverSideEncryptionString().
    
    Returns:
    
    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
    
    See Also:
    
    ServerSideEncryption
  - storageClass
```
public StorageClass storageClass()
```
    The type of storage to use for the object. Defaults to 'STANDARD'.
    If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassString().
    
    Returns:
    
    The type of storage to use for the object. Defaults to 'STANDARD'.
    
    See Also:
    
    StorageClass
  - storageClassString
```
public String storageClassString()
```
    The type of storage to use for the object. Defaults to 'STANDARD'.
    If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassString().
    
    Returns:
    
    The type of storage to use for the object. Defaults to 'STANDARD'.
    
    See Also:
    
    StorageClass
  - websiteRedirectLocation
```
public String websiteRedirectLocation()
```
    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
    
    Returns:
    
    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
  - sseCustomerAlgorithm
```
public String sseCustomerAlgorithm()
```
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
    
    Returns:
    
    Specifies the algorithm to use to when encrypting the object (e.g., AES256).
  - sseCustomerKey
```
public String sseCustomerKey()
```
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
    
    Returns:
    
    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
  - sseCustomerKeyMD5
```
public String sseCustomerKeyMD5()
```
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
    
    Returns:
    
    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
  - ssekmsKeyId
```
public String ssekmsKeyId()
```
    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
    
    Returns:
    
    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
  - requestPayer
```
public RequestPayer requestPayer()
```
    Returns the value of the RequestPayer property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - requestPayerString
```
public String requestPayerString()
```
    Returns the value of the RequestPayer property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - tagging
```
public String tagging()
```
    The tag-set for the object. The tag-set must be encoded as URL Query parameters
    
    Returns:
    
    The tag-set for the object. The tag-set must be encoded as URL Query parameters
  - toBuilder
```
public PutObjectRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static PutObjectRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutObjectRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest

Class PutObjectRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

acl

aclString

bucket

cacheControl

contentDisposition

contentEncoding

contentLanguage

contentLength

contentMD5

contentType

expires

grantFullControl

grantRead

grantReadACP

grantWriteACP

key

metadata

serverSideEncryption

serverSideEncryptionString

storageClass

storageClassString

websiteRedirectLocation

sseCustomerAlgorithm

sseCustomerKey

sseCustomerKeyMD5

ssekmsKeyId

requestPayer

requestPayerString

tagging

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField