com.oracle.bmc.objectstorage.requests

Class PutObjectRequest.Builder

java.lang.Object

com.oracle.bmc.objectstorage.requests.PutObjectRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<PutObjectRequest,InputStream>

Enclosing class:

PutObjectRequest

public static class PutObjectRequest.Builder
extends Object
implements BmcRequest.Builder<PutObjectRequest,InputStream>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PutObjectRequest.Builder	body$(InputStream body) Alternative setter for the body parameter.
PutObjectRequest.Builder	bucketName(String bucketName) The name of the bucket.
PutObjectRequest	build() Build the instance of PutObjectRequest as configured by this builder
PutObjectRequest	buildWithoutInvocationCallback() Build the instance of PutObjectRequest as configured by this builder
PutObjectRequest.Builder	cacheControl(String cacheControl) The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and HeadObject responses.
PutObjectRequest.Builder	contentDisposition(String contentDisposition) The optional Content-Disposition header that defines presentational information for the object to be returned in GetObject and HeadObject responses.
PutObjectRequest.Builder	contentEncoding(String contentEncoding) The optional Content-Encoding header that defines the content encodings that were applied to the object to upload.
PutObjectRequest.Builder	contentLanguage(String contentLanguage) The optional Content-Language header that defines the content language of the object to upload.
PutObjectRequest.Builder	contentLength(Long contentLength) The content length of the body.
PutObjectRequest.Builder	contentMD5(String contentMD5) The optional header that defines the base64-encoded MD5 hash of the body.
PutObjectRequest.Builder	contentType(String contentType) The optional Content-Type header that defines the standard MIME type format of the object.
PutObjectRequest.Builder	copy(PutObjectRequest o) Copy method to populate the builder with values from the given instance.
PutObjectRequest.Builder	expect(String expect) A value of 100-continue requests preliminary verification of the request method, path, and headers before the request body is sent.
PutObjectRequest.Builder	ifMatch(String ifMatch) The entity tag (ETag) to match with the ETag of an existing resource.
PutObjectRequest.Builder	ifNoneMatch(String ifNoneMatch) The entity tag (ETag) to avoid matching.
PutObjectRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
PutObjectRequest.Builder	namespaceName(String namespaceName) The Object Storage namespace used for the request.
PutObjectRequest.Builder	objectName(String objectName) The name of the object.
PutObjectRequest.Builder	opcClientRequestId(String opcClientRequestId) The client request ID for tracing.
PutObjectRequest.Builder	opcMeta(Map<String,String> opcMeta) Optional user-defined metadata key and value.
PutObjectRequest.Builder	opcSseCustomerAlgorithm(String opcSseCustomerAlgorithm) The optional header that specifies “AES256” as the encryption algorithm.
PutObjectRequest.Builder	opcSseCustomerKey(String opcSseCustomerKey) The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data.
PutObjectRequest.Builder	opcSseCustomerKeySha256(String opcSseCustomerKeySha256) The optional header that specifies the base64-encoded SHA256 hash of the encryption key.
PutObjectRequest.Builder	opcSseKmsKeyId(String opcSseKmsKeyId) 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.
PutObjectRequest.Builder	putObjectBody(InputStream putObjectBody) The object to upload to the object store.
PutObjectRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
PutObjectRequest.Builder	storageTier(StorageTier storageTier) The storage tier that the object should be stored in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

namespaceName

public PutObjectRequest.Builder namespaceName(String namespaceName)

The Object Storage namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

bucketName

public PutObjectRequest.Builder bucketName(String bucketName)

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

Parameters:

bucketName - the value to set

Returns:

this builder instance

objectName

public PutObjectRequest.Builder objectName(String objectName)

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

Parameters:

objectName - the value to set

Returns:

this builder instance

contentLength

public PutObjectRequest.Builder contentLength(Long contentLength)

The content length of the body.

Parameters:

contentLength - the value to set

Returns:

this builder instance

putObjectBody

public PutObjectRequest.Builder putObjectBody(InputStream putObjectBody)

The object to upload to the object store.

Parameters:

putObjectBody - the value to set

Returns:

this builder instance

ifMatch

public PutObjectRequest.Builder ifMatch(String ifMatch)

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.

Parameters:

ifMatch - the value to set

Returns:

this builder instance

ifNoneMatch

public PutObjectRequest.Builder ifNoneMatch(String ifNoneMatch)

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

Parameters:

ifNoneMatch - the value to set

Returns:

this builder instance

opcClientRequestId

public PutObjectRequest.Builder opcClientRequestId(String opcClientRequestId)

The client request ID for tracing.

Parameters:

opcClientRequestId - the value to set

Returns:

this builder instance

expect

public PutObjectRequest.Builder expect(String expect)

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).

Parameters:

expect - the value to set

Returns:

this builder instance

contentMD5

public PutObjectRequest.Builder contentMD5(String contentMD5)

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)"

Parameters:

contentMD5 - the value to set

Returns:

this builder instance

contentType

public PutObjectRequest.Builder contentType(String contentType)

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.

Parameters:

contentType - the value to set

Returns:

this builder instance

contentLanguage

public PutObjectRequest.Builder contentLanguage(String contentLanguage)

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.

Parameters:

contentLanguage - the value to set

Returns:

this builder instance

contentEncoding

public PutObjectRequest.Builder contentEncoding(String contentEncoding)

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.

Parameters:

contentEncoding - the value to set

Returns:

this builder instance

contentDisposition

public PutObjectRequest.Builder contentDisposition(String contentDisposition)

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.

Parameters:

contentDisposition - the value to set

Returns:

this builder instance

cacheControl

public PutObjectRequest.Builder cacheControl(String cacheControl)

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.

Parameters:

cacheControl - the value to set

Returns:

this builder instance

opcSseCustomerAlgorithm

public PutObjectRequest.Builder opcSseCustomerAlgorithm(String opcSseCustomerAlgorithm)

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

Parameters:

opcSseCustomerAlgorithm - the value to set

Returns:

this builder instance

opcSseCustomerKey

public PutObjectRequest.Builder opcSseCustomerKey(String opcSseCustomerKey)

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.

Parameters:

opcSseCustomerKey - the value to set

Returns:

this builder instance

opcSseCustomerKeySha256

public PutObjectRequest.Builder opcSseCustomerKeySha256(String opcSseCustomerKeySha256)

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.

Parameters:

opcSseCustomerKeySha256 - the value to set

Returns:

this builder instance

opcSseKmsKeyId

public PutObjectRequest.Builder opcSseKmsKeyId(String opcSseKmsKeyId)

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.

Parameters:

opcSseKmsKeyId - the value to set

Returns:

this builder instance

storageTier

public PutObjectRequest.Builder storageTier(StorageTier 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.

Parameters:

storageTier - the value to set

Returns:

this builder instance

opcMeta

public PutObjectRequest.Builder opcMeta(Map<String,String> opcMeta)

Optional user-defined metadata key and value.

Parameters:

opcMeta - the value to set

Returns:

this builder instance

invocationCallback

public PutObjectRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public PutObjectRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public PutObjectRequest.Builder copy(PutObjectRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<PutObjectRequest,InputStream>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public PutObjectRequest build()

Build the instance of PutObjectRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<PutObjectRequest,InputStream>

Returns:

instance of PutObjectRequest

body$

public PutObjectRequest.Builder body$(InputStream body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<PutObjectRequest,InputStream>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public PutObjectRequest buildWithoutInvocationCallback()

Build the instance of PutObjectRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of PutObjectRequest