Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PutObjectRequest

example

Click here to see how to use PutObjectRequest.

Hierarchy

Properties

bucketName

bucketName: string

The name of the bucket. Avoid entering confidential information. Example: {@code my-new-bucket1}

Optional cacheControl

cacheControl: undefined | string

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.

Optional contentDisposition

contentDisposition: undefined | string

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.

Optional contentEncoding

contentEncoding: undefined | string

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.

Optional contentLanguage

contentLanguage: undefined | string

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.

Optional contentLength

contentLength: undefined | number

The content length of the body.

Optional contentMD5

contentMD5: undefined | string

The optional base-64 header that defines the 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)\"

Optional contentType

contentType: undefined | string

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.

Optional expect

expect: undefined | string

A value of {@code 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).

Optional ifMatch

ifMatch: undefined | string

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.

Optional ifNoneMatch

ifNoneMatch: undefined | string

The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should fail if the resource already exists.

namespaceName

namespaceName: string

The Object Storage namespace used for the request.

objectName

objectName: string

The name of the object. Avoid entering confidential information. Example: {@code test/object1.log}

Optional opcClientRequestId

opcClientRequestId: undefined | string

The client request ID for tracing.

Optional opcMeta

opcMeta: undefined | object

Optional user-defined metadata key and value.

Optional opcSseCustomerAlgorithm

opcSseCustomerAlgorithm: undefined | string

The optional header that specifies "AES256" as the encryption algorithm. For more information, see Using Your Own Keys for Server-Side Encryption.

Optional opcSseCustomerKey

opcSseCustomerKey: undefined | string

The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data. For more information, see Using Your Own Keys for Server-Side Encryption.

Optional opcSseCustomerKeySha256

opcSseCustomerKeySha256: undefined | string

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.

Optional opcSseKmsKeyId

opcSseKmsKeyId: undefined | string

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.

putObjectBody

putObjectBody: Uint8Array | Buffer | Blob | stream.Readable | ReadableStream | string

The object to upload to the object store.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional storageTier

storageTier: model.StorageTier

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.