Package com.oracle.bmc.objectstorage.requests

Class PutObjectRequest

  • All Implemented Interfaces:
    HasContentLength
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class PutObjectRequest
extends BmcRequest<InputStream>
implements HasContentLength

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/objectstorage/PutObjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PutObjectRequest.

    • Constructor Detail

      • PutObjectRequest

        public PutObjectRequest()

    • Method Detail

      • getNamespaceName

        public String getNamespaceName()
        The Object Storage namespace used for the request.

      • getBucketName

        public String getBucketName()
        The name of the bucket.

        Avoid entering confidential information. Example: my-new-bucket1

      • getObjectName

        public String getObjectName()
        The name of the object.

        Avoid entering confidential information. Example: test/object1.log

      • getPutObjectBody

        public InputStream getPutObjectBody()
        The object to upload to the object store.

      • getIfMatch

        public String getIfMatch()
        The entity tag (ETag) to match with the ETag of an existing resource.

        If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource.

      • getIfNoneMatch

        public String getIfNoneMatch()
        The entity tag (ETag) to avoid matching.

        The only valid value is ‘*’, which indicates that the request should fail if the resource already exists.

      • getOpcClientRequestId

        public String getOpcClientRequestId()
        The client request ID for tracing.

      • getExpect

        public String getExpect()
        A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent.

        If no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body. The only allowed value for this parameter is “100-Continue” (case-insensitive).

      • getContentMD5

        public String getContentMD5()
        The optional header that defines the base64-encoded MD5 hash of the body.

        If the optional Content-MD5 header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error is returned with the message:

        "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

      • getOpcChecksumAlgorithm

        public ChecksumAlgorithm getOpcChecksumAlgorithm()
        The optional checksum algorithm to use to compute and store the checksum of the body of the HTTP request (or the parts in case of multipart uploads), in addition to the default MD5 checksum.

      • getOpcContentCrc32c

        public String getOpcContentCrc32c()
        Applicable only if CRC32C is specified in the opc-checksum-algorithm request header.

        The optional header that defines the base64-encoded, 32-bit CRC32C (Castagnoli) checksum of the body. If the optional opc-content-crc32c header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the CRC32C checksum for the body and comparing it to the CRC32C checksum supplied in the header. If the two checksums do not match, the object is rejected and an HTTP-400 Unmatched Content CRC32C error is returned with the message:

        "The computed CRC32C of the request body (ACTUAL_CRC32C) does not match the opc-content-crc32c header (HEADER_CRC32C)"

      • getOpcContentSha256

        public String getOpcContentSha256()
        Applicable only if SHA256 is specified in the opc-checksum-algorithm request header.

        The optional header that defines the base64-encoded SHA256 hash of the body. If the optional opc-content-sha256 header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the SHA256 hash for the body and comparing it to the SHA256 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content SHA256 error is returned with the message:

        "The computed SHA256 of the request body (ACTUAL_SHA256) does not match the opc-content-sha256 header (HEADER_SHA256)"

      • getOpcContentSha384

        public String getOpcContentSha384()
        Applicable only if SHA384 is specified in the opc-checksum-algorithm request header.

        The optional header that defines the base64-encoded SHA384 hash of the body. If the optional opc-content-sha384 header is present, Object Storage performs an integrity check on the body of the HTTP request by computing the SHA384 hash for the body and comparing it to the SHA384 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content SHA384 error is returned with the message:

        "The computed SHA384 of the request body (ACTUAL_SHA384) does not match the opc-content-sha384 header (HEADER_SHA384)"

      • getContentType

        public String getContentType()
        The optional Content-Type header that defines the standard MIME type format of the object.

        Content type defaults to ‘application/octet-stream’ if not specified in the PutObject call. Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to identify and perform special operations on text only objects.

      • getContentLanguage

        public String getContentLanguage()
        The optional Content-Language header that defines the content language of the object to upload.

        Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to identify and differentiate objects based on a particular language.

      • getContentEncoding

        public String getContentEncoding()
        The optional Content-Encoding header that defines the content encodings that were applied to the object to upload.

        Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to determine what decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of the object.

      • getContentDisposition

        public String getContentDisposition()
        The optional Content-Disposition header that defines presentational information for the object to be returned in GetObject and HeadObject responses.

        Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to let users download objects with custom filenames in a browser.

      • getCacheControl

        public String getCacheControl()
        The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and HeadObject responses.

        Specifying values for this header has no effect on Object Storage behavior. Programs that read the object determine what to do based on the value provided. For example, you could use this header to identify objects that require caching restrictions.

      • getOpcSseCustomerKeySha256

        public String getOpcSseCustomerKeySha256()
        The optional header that specifies the base64-encoded SHA256 hash of the encryption key.

        This value is used to check the integrity of the encryption key. For more information, see Using Your Own Keys for Server-Side Encryption.

      • getOpcSseKmsKeyId

        public String getOpcSseKmsKeyId()
        The OCID of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.

      • getStorageTier

        public StorageTier getStorageTier()
        The storage tier that the object should be stored in.

        If not specified, the object will be stored in the same storage tier as the bucket.

      • getOpcMeta

        public Map<String,​String> getOpcMeta()
        Optional user-defined metadata key and value.

      • supportsExpect100Continue

        public boolean supportsExpect100Continue()
        Description copied from class: BmcRequest
        Returns true if this operation supports Expect: 100-Continue.
        Overrides:
        supportsExpect100Continue in class BmcRequest<InputStream>
        Returns:
        true if this operation supports Expect: 100-Continue.

      • builder

        public static PutObjectRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request object

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<InputStream>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<InputStream>