Class UploadPartRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.objectstorage.requests.UploadPartRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<UploadPartRequest,InputStream>
- Enclosing class:
- UploadPartRequest
public static class UploadPartRequest.Builder extends Object implements BmcRequest.Builder<UploadPartRequest,InputStream>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UploadPartRequest.Builder
body$(InputStream body)
Alternative setter for the body parameter.UploadPartRequest.Builder
bucketName(String bucketName)
The name of the bucket.UploadPartRequest
build()
Build the instance of UploadPartRequest as configured by this builderUploadPartRequest
buildWithoutInvocationCallback()
Build the instance of UploadPartRequest as configured by this builderUploadPartRequest.Builder
contentLength(Long contentLength)
The content length of the body.UploadPartRequest.Builder
contentMD5(String contentMD5)
The optional header that defines the base64-encoded MD5 hash of the body.UploadPartRequest.Builder
copy(UploadPartRequest o)
Copy method to populate the builder with values from the given instance.UploadPartRequest.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.UploadPartRequest.Builder
ifMatch(String ifMatch)
The entity tag (ETag) to match with the ETag of an existing resource.UploadPartRequest.Builder
ifNoneMatch(String ifNoneMatch)
The entity tag (ETag) to avoid matching.UploadPartRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.UploadPartRequest.Builder
namespaceName(String namespaceName)
The Object Storage namespace used for the request.UploadPartRequest.Builder
objectName(String objectName)
The name of the object.UploadPartRequest.Builder
opcChecksumAlgorithm(ChecksumAlgorithm opcChecksumAlgorithm)
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.UploadPartRequest.Builder
opcClientRequestId(String opcClientRequestId)
The client request ID for tracing.UploadPartRequest.Builder
opcContentCrc32c(String opcContentCrc32c)
Applicable only if CRC32C is specified in the opc-checksum-algorithm request header.UploadPartRequest.Builder
opcContentSha256(String opcContentSha256)
Applicable only if SHA256 is specified in the opc-checksum-algorithm request header.UploadPartRequest.Builder
opcContentSha384(String opcContentSha384)
Applicable only if SHA384 is specified in the opc-checksum-algorithm request header.UploadPartRequest.Builder
opcSseCustomerAlgorithm(String opcSseCustomerAlgorithm)
The optional header that specifies “AES256” as the encryption algorithm.UploadPartRequest.Builder
opcSseCustomerKey(String opcSseCustomerKey)
The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data.UploadPartRequest.Builder
opcSseCustomerKeySha256(String opcSseCustomerKeySha256)
The optional header that specifies the base64-encoded SHA256 hash of the encryption key.UploadPartRequest.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.UploadPartRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.UploadPartRequest.Builder
uploadId(String uploadId)
The upload ID for a multipart upload.UploadPartRequest.Builder
uploadPartBody(InputStream uploadPartBody)
The part being uploaded to the Object Storage service.UploadPartRequest.Builder
uploadPartNum(Integer uploadPartNum)
The part number that identifies the object part currently being uploaded.
-
-
-
Method Detail
-
namespaceName
public UploadPartRequest.Builder namespaceName(String namespaceName)
The Object Storage namespace used for the request.- Parameters:
namespaceName
- the value to set- Returns:
- this builder instance
-
bucketName
public UploadPartRequest.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 UploadPartRequest.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
-
uploadId
public UploadPartRequest.Builder uploadId(String uploadId)
The upload ID for a multipart upload.- Parameters:
uploadId
- the value to set- Returns:
- this builder instance
-
uploadPartNum
public UploadPartRequest.Builder uploadPartNum(Integer uploadPartNum)
The part number that identifies the object part currently being uploaded.- Parameters:
uploadPartNum
- the value to set- Returns:
- this builder instance
-
contentLength
public UploadPartRequest.Builder contentLength(Long contentLength)
The content length of the body.- Parameters:
contentLength
- the value to set- Returns:
- this builder instance
-
uploadPartBody
public UploadPartRequest.Builder uploadPartBody(InputStream uploadPartBody)
The part being uploaded to the Object Storage service.- Parameters:
uploadPartBody
- the value to set- Returns:
- this builder instance
-
opcClientRequestId
public UploadPartRequest.Builder opcClientRequestId(String opcClientRequestId)
The client request ID for tracing.- Parameters:
opcClientRequestId
- the value to set- Returns:
- this builder instance
-
ifMatch
public UploadPartRequest.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 UploadPartRequest.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
-
expect
public UploadPartRequest.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 UploadPartRequest.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
-
opcChecksumAlgorithm
public UploadPartRequest.Builder opcChecksumAlgorithm(ChecksumAlgorithm opcChecksumAlgorithm)
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.- Parameters:
opcChecksumAlgorithm
- the value to set- Returns:
- this builder instance
-
opcContentCrc32c
public UploadPartRequest.Builder opcContentCrc32c(String opcContentCrc32c)
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)"
- Parameters:
opcContentCrc32c
- the value to set- Returns:
- this builder instance
-
opcContentSha256
public UploadPartRequest.Builder opcContentSha256(String opcContentSha256)
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)"
- Parameters:
opcContentSha256
- the value to set- Returns:
- this builder instance
-
opcContentSha384
public UploadPartRequest.Builder opcContentSha384(String opcContentSha384)
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)"
- Parameters:
opcContentSha384
- the value to set- Returns:
- this builder instance
-
opcSseCustomerAlgorithm
public UploadPartRequest.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 UploadPartRequest.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 UploadPartRequest.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 UploadPartRequest.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
-
invocationCallback
public UploadPartRequest.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 UploadPartRequest.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 UploadPartRequest.Builder copy(UploadPartRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<UploadPartRequest,InputStream>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public UploadPartRequest build()
Build the instance of UploadPartRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<UploadPartRequest,InputStream>
- Returns:
- instance of UploadPartRequest
-
body$
public UploadPartRequest.Builder body$(InputStream body)
Alternative setter for the body parameter.- Specified by:
body$
in interfaceBmcRequest.Builder<UploadPartRequest,InputStream>
- Parameters:
body
- the body parameter- Returns:
- this builder instance
-
buildWithoutInvocationCallback
public UploadPartRequest buildWithoutInvocationCallback()
Build the instance of UploadPartRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of UploadPartRequest
-
-