com.oracle.bmc.objectstorage.requests

Class CopyObjectRequest.Builder

java.lang.Object

com.oracle.bmc.objectstorage.requests.CopyObjectRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<CopyObjectRequest,CopyObjectDetails>

Enclosing class:

CopyObjectRequest

public static class CopyObjectRequest.Builder
extends Object
implements BmcRequest.Builder<CopyObjectRequest,CopyObjectDetails>

Method Summary

Modifier and Type	Method and Description
CopyObjectRequest.Builder	body$(CopyObjectDetails body) Alternative setter for the body parameter.
CopyObjectRequest.Builder	bucketName(String bucketName) The name of the bucket.
CopyObjectRequest	build() Build the instance of CopyObjectRequest as configured by this builder
CopyObjectRequest	buildWithoutInvocationCallback()
CopyObjectRequest.Builder	copy(CopyObjectRequest o) Copy method to populate the builder with values from the given instance.
CopyObjectRequest.Builder	copyObjectDetails(CopyObjectDetails copyObjectDetails) The source and destination of the object to be copied.
CopyObjectRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
CopyObjectRequest.Builder	namespaceName(String namespaceName) The Object Storage namespace used for the request.
CopyObjectRequest.Builder	opcClientRequestId(String opcClientRequestId) The client request ID for tracing.
CopyObjectRequest.Builder	opcSourceSseCustomerAlgorithm(String opcSourceSseCustomerAlgorithm) The optional header that specifies “AES256” as the encryption algorithm to use to decrypt the source object.
CopyObjectRequest.Builder	opcSourceSseCustomerKey(String opcSourceSseCustomerKey) The optional header that specifies the base64-encoded 256-bit encryption key to use to decrypt the source object.
CopyObjectRequest.Builder	opcSourceSseCustomerKeySha256(String opcSourceSseCustomerKeySha256) The optional header that specifies the base64-encoded SHA256 hash of the encryption key used to decrypt the source object.
CopyObjectRequest.Builder	opcSseCustomerAlgorithm(String opcSseCustomerAlgorithm) The optional header that specifies “AES256” as the encryption algorithm.
CopyObjectRequest.Builder	opcSseCustomerKey(String opcSseCustomerKey) The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data.
CopyObjectRequest.Builder	opcSseCustomerKeySha256(String opcSseCustomerKeySha256) The optional header that specifies the base64-encoded SHA256 hash of the encryption key.
CopyObjectRequest.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.
CopyObjectRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

invocationCallback

public CopyObjectRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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 CopyObjectRequest.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 CopyObjectRequest.Builder copy(CopyObjectRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<CopyObjectRequest,CopyObjectDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public CopyObjectRequest build()

Build the instance of CopyObjectRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.util.internal.Consumer) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<CopyObjectRequest,CopyObjectDetails>

Returns:

instance of CopyObjectRequest

body$

public CopyObjectRequest.Builder body$(CopyObjectDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<CopyObjectRequest,CopyObjectDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

namespaceName

public CopyObjectRequest.Builder namespaceName(String namespaceName)

The Object Storage namespace used for the request.

Returns:

this.

bucketName

public CopyObjectRequest.Builder bucketName(String bucketName)

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

Returns:

this.

copyObjectDetails

public CopyObjectRequest.Builder copyObjectDetails(CopyObjectDetails copyObjectDetails)

The source and destination of the object to be copied.

Returns:

this.

opcClientRequestId

public CopyObjectRequest.Builder opcClientRequestId(String opcClientRequestId)

The client request ID for tracing.

Returns:

this.

opcSseCustomerAlgorithm

public CopyObjectRequest.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.

Returns:

this.

opcSseCustomerKey

public CopyObjectRequest.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.

Returns:

this.

opcSseCustomerKeySha256

public CopyObjectRequest.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.

Returns:

this.

opcSourceSseCustomerAlgorithm

public CopyObjectRequest.Builder opcSourceSseCustomerAlgorithm(String opcSourceSseCustomerAlgorithm)

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

Returns:

this.

opcSourceSseCustomerKey

public CopyObjectRequest.Builder opcSourceSseCustomerKey(String opcSourceSseCustomerKey)

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

Returns:

this.

opcSourceSseCustomerKeySha256

public CopyObjectRequest.Builder opcSourceSseCustomerKeySha256(String opcSourceSseCustomerKeySha256)

The optional header that specifies the base64-encoded SHA256 hash of the encryption key used to decrypt the source object. This value is used to check the integrity of the encryption key. For more information, see Using Your Own Keys for Server-Side Encryption.

Returns:

this.

opcSseKmsKeyId

public CopyObjectRequest.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.

Returns:

this.

buildWithoutInvocationCallback

public CopyObjectRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object