Class PutObjectRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.restxmldataplane.model.RestXmlDataPlaneRequest
software.amazon.awssdk.services.restxmldataplane.model.PutObjectRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutObjectRequest extends RestXmlDataPlaneRequest implements ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>

  • Method Details

    • bucket

      public final String bucket()
      Returns the value of the Bucket property for this object.
      Returns:
      The value of the Bucket property for this object.

    • key

      public final String key()
      Returns the value of the Key property for this object.
      Returns:
      The value of the Key property for this object.

    • body

      public final SdkBytes body()
      Returns the value of the Body property for this object.
      Returns:
      The value of the Body property for this object.

    • acl

      public final String acl()
      Returns the value of the ACL property for this object.
      Returns:
      The value of the ACL property for this object.

    • cacheControl

      public final String cacheControl()
      Returns the value of the CacheControl property for this object.
      Returns:
      The value of the CacheControl property for this object.

    • contentDisposition

      public final String contentDisposition()
      Returns the value of the ContentDisposition property for this object.
      Returns:
      The value of the ContentDisposition property for this object.

    • contentEncoding

      public final String contentEncoding()
      Returns the value of the ContentEncoding property for this object.
      Returns:
      The value of the ContentEncoding property for this object.

    • contentLanguage

      public final String contentLanguage()
      Returns the value of the ContentLanguage property for this object.
      Returns:
      The value of the ContentLanguage property for this object.

    • contentLength

      public final Long contentLength()
      Returns the value of the ContentLength property for this object.
      Returns:
      The value of the ContentLength property for this object.

    • contentMD5

      public final String contentMD5()
      Returns the value of the ContentMD5 property for this object.
      Returns:
      The value of the ContentMD5 property for this object.

    • contentType

      public final String contentType()
      Returns the value of the ContentType property for this object.
      Returns:
      The value of the ContentType property for this object.

    • checksumAlgorithm

      public final ChecksumAlgorithm checksumAlgorithm()
      Returns the value of the ChecksumAlgorithm property for this object.

      If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

      Returns:
      The value of the ChecksumAlgorithm property for this object.
      See Also:

    • checksumAlgorithmAsString

      public final String checksumAlgorithmAsString()
      Returns the value of the ChecksumAlgorithm property for this object.

      If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().

      Returns:
      The value of the ChecksumAlgorithm property for this object.
      See Also:

    • checksumCRC32

      public final String checksumCRC32()
      Returns the value of the ChecksumCRC32 property for this object.
      Returns:
      The value of the ChecksumCRC32 property for this object.

    • checksumCRC32C

      public final String checksumCRC32C()
      Returns the value of the ChecksumCRC32C property for this object.
      Returns:
      The value of the ChecksumCRC32C property for this object.

    • checksumCRC64NVME

      public final String checksumCRC64NVME()
      Returns the value of the ChecksumCRC64NVME property for this object.
      Returns:
      The value of the ChecksumCRC64NVME property for this object.

    • checksumSHA1

      public final String checksumSHA1()
      Returns the value of the ChecksumSHA1 property for this object.
      Returns:
      The value of the ChecksumSHA1 property for this object.

    • checksumSHA256

      public final String checksumSHA256()
      Returns the value of the ChecksumSHA256 property for this object.
      Returns:
      The value of the ChecksumSHA256 property for this object.

    • expires

      public final Instant expires()
      Returns the value of the Expires property for this object.
      Returns:
      The value of the Expires property for this object.

    • ifMatch

      public final String ifMatch()
      Returns the value of the IfMatch property for this object.
      Returns:
      The value of the IfMatch property for this object.

    • ifNoneMatch

      public final String ifNoneMatch()
      Returns the value of the IfNoneMatch property for this object.
      Returns:
      The value of the IfNoneMatch property for this object.

    • grantFullControl

      public final String grantFullControl()
      Returns the value of the GrantFullControl property for this object.
      Returns:
      The value of the GrantFullControl property for this object.

    • grantRead

      public final String grantRead()
      Returns the value of the GrantRead property for this object.
      Returns:
      The value of the GrantRead property for this object.

    • grantReadACP

      public final String grantReadACP()
      Returns the value of the GrantReadACP property for this object.
      Returns:
      The value of the GrantReadACP property for this object.

    • grantWriteACP

      public final String grantWriteACP()
      Returns the value of the GrantWriteACP property for this object.
      Returns:
      The value of the GrantWriteACP property for this object.

    • writeOffsetBytes

      public final Long writeOffsetBytes()
      Returns the value of the WriteOffsetBytes property for this object.
      Returns:
      The value of the WriteOffsetBytes property for this object.

    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata 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.

    • metadata

      public final Map<String,String> metadata()
      Returns the value of the Metadata 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 hasMetadata() method.

      Returns:
      The value of the Metadata property for this object.

    • serverSideEncryption

      public final String serverSideEncryption()
      Returns the value of the ServerSideEncryption property for this object.
      Returns:
      The value of the ServerSideEncryption property for this object.

    • storageClass

      public final String storageClass()
      Returns the value of the StorageClass property for this object.
      Returns:
      The value of the StorageClass property for this object.

    • websiteRedirectLocation

      public final String websiteRedirectLocation()
      Returns the value of the WebsiteRedirectLocation property for this object.
      Returns:
      The value of the WebsiteRedirectLocation property for this object.

    • sseCustomerAlgorithm

      public final String sseCustomerAlgorithm()
      Returns the value of the SSECustomerAlgorithm property for this object.
      Returns:
      The value of the SSECustomerAlgorithm property for this object.

    • sseCustomerKey

      public final String sseCustomerKey()
      Returns the value of the SSECustomerKey property for this object.
      Returns:
      The value of the SSECustomerKey property for this object.

    • sseCustomerKeyMD5

      public final String sseCustomerKeyMD5()
      Returns the value of the SSECustomerKeyMD5 property for this object.
      Returns:
      The value of the SSECustomerKeyMD5 property for this object.

    • ssekmsKeyId

      public final String ssekmsKeyId()
      Returns the value of the SSEKMSKeyId property for this object.
      Returns:
      The value of the SSEKMSKeyId property for this object.

    • ssekmsEncryptionContext

      public final String ssekmsEncryptionContext()
      Returns the value of the SSEKMSEncryptionContext property for this object.
      Returns:
      The value of the SSEKMSEncryptionContext property for this object.

    • bucketKeyEnabled

      public final Boolean bucketKeyEnabled()
      Returns the value of the BucketKeyEnabled property for this object.
      Returns:
      The value of the BucketKeyEnabled property for this object.

    • requestPayer

      public final String requestPayer()
      Returns the value of the RequestPayer property for this object.
      Returns:
      The value of the RequestPayer property for this object.

    • tagging

      public final String tagging()
      Returns the value of the Tagging property for this object.
      Returns:
      The value of the Tagging property for this object.

    • objectLockMode

      public final String objectLockMode()
      Returns the value of the ObjectLockMode property for this object.
      Returns:
      The value of the ObjectLockMode property for this object.

    • objectLockRetainUntilDate

      public final Instant objectLockRetainUntilDate()
      Returns the value of the ObjectLockRetainUntilDate property for this object.
      Returns:
      The value of the ObjectLockRetainUntilDate property for this object.

    • objectLockLegalHoldStatus

      public final String objectLockLegalHoldStatus()
      Returns the value of the ObjectLockLegalHoldStatus property for this object.
      Returns:
      The value of the ObjectLockLegalHoldStatus property for this object.

    • expectedBucketOwner

      public final String expectedBucketOwner()
      Returns the value of the ExpectedBucketOwner property for this object.
      Returns:
      The value of the ExpectedBucketOwner property for this object.

    • toBuilder

      public PutObjectRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
      Specified by:
      toBuilder in class RestXmlDataPlaneRequest
      Returns:
      a builder for type T

    • builder

      public static PutObjectRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutObjectRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.