com.oracle.bmc.objectstorage.requests

Class HeadObjectRequest.Builder

java.lang.Object

com.oracle.bmc.objectstorage.requests.HeadObjectRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<HeadObjectRequest,Void>

Enclosing class:

HeadObjectRequest

public static class HeadObjectRequest.Builder
extends Object
implements BmcRequest.Builder<HeadObjectRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HeadObjectRequest.Builder	bucketName(String bucketName) The name of the bucket.
HeadObjectRequest	build() Build the instance of HeadObjectRequest as configured by this builder
HeadObjectRequest	buildWithoutInvocationCallback() Build the instance of HeadObjectRequest as configured by this builder
HeadObjectRequest.Builder	copy(HeadObjectRequest o) Copy method to populate the builder with values from the given instance.
HeadObjectRequest.Builder	ifMatch(String ifMatch) The entity tag (ETag) to match with the ETag of an existing resource.
HeadObjectRequest.Builder	ifNoneMatch(String ifNoneMatch) The entity tag (ETag) to avoid matching.
HeadObjectRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
HeadObjectRequest.Builder	namespaceName(String namespaceName) The Object Storage namespace used for the request.
HeadObjectRequest.Builder	objectName(String objectName) The name of the object.
HeadObjectRequest.Builder	opcClientRequestId(String opcClientRequestId) The client request ID for tracing.
HeadObjectRequest.Builder	opcSseCustomerAlgorithm(String opcSseCustomerAlgorithm) The optional header that specifies “AES256” as the encryption algorithm.
HeadObjectRequest.Builder	opcSseCustomerKey(String opcSseCustomerKey) The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or decrypt the data.
HeadObjectRequest.Builder	opcSseCustomerKeySha256(String opcSseCustomerKeySha256) The optional header that specifies the base64-encoded SHA256 hash of the encryption key.
HeadObjectRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
HeadObjectRequest.Builder	versionId(String versionId) VersionId used to identify a particular version of the object

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

namespaceName

public HeadObjectRequest.Builder namespaceName(String namespaceName)

The Object Storage namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

bucketName

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

versionId

public HeadObjectRequest.Builder versionId(String versionId)

VersionId used to identify a particular version of the object

Parameters:

versionId - the value to set

Returns:

this builder instance

ifMatch

public HeadObjectRequest.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 HeadObjectRequest.Builder ifNoneMatch(String ifNoneMatch)

The entity tag (ETag) to avoid matching. Wildcards (‘*’) are not allowed. If the specified ETag does not match the ETag of the existing resource, the request returns the expected response. If the ETag matches the ETag of the existing resource, the request returns an HTTP 304 status without a response body.

Parameters:

ifNoneMatch - the value to set

Returns:

this builder instance

opcClientRequestId

public HeadObjectRequest.Builder opcClientRequestId(String opcClientRequestId)

The client request ID for tracing.

Parameters:

opcClientRequestId - the value to set

Returns:

this builder instance

opcSseCustomerAlgorithm

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

invocationCallback

public HeadObjectRequest.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 HeadObjectRequest.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 HeadObjectRequest.Builder copy(HeadObjectRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<HeadObjectRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public HeadObjectRequest build()

Build the instance of HeadObjectRequest 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<HeadObjectRequest,Void>

Returns:

instance of HeadObjectRequest

buildWithoutInvocationCallback

public HeadObjectRequest buildWithoutInvocationCallback()

Build the instance of HeadObjectRequest 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 HeadObjectRequest