Package com.oracle.bmc.keymanagement.requests

Class RestoreKeyFromFileRequest.Builder

java.lang.Object

com.oracle.bmc.keymanagement.requests.RestoreKeyFromFileRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<RestoreKeyFromFileRequest,InputStream>

Enclosing class:

RestoreKeyFromFileRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RestoreKeyFromFileRequest.Builder	body$(InputStream body)	Alternative setter for the body parameter.
RestoreKeyFromFileRequest	build()	Build the instance of RestoreKeyFromFileRequest as configured by this builder
RestoreKeyFromFileRequest	buildWithoutInvocationCallback()	Build the instance of RestoreKeyFromFileRequest as configured by this builder
RestoreKeyFromFileRequest.Builder	contentLength(Long contentLength)	The content length of the body.
RestoreKeyFromFileRequest.Builder	contentMd5(String contentMd5)	The base64-encoded MD5 hash value of the body, as described in RFC 2616, section 14.15.
RestoreKeyFromFileRequest.Builder	copy(RestoreKeyFromFileRequest o)	Copy method to populate the builder with values from the given instance.
RestoreKeyFromFileRequest.Builder	ifMatch(String ifMatch)	For optimistic concurrency control.
RestoreKeyFromFileRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
RestoreKeyFromFileRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
RestoreKeyFromFileRequest.Builder	opcRetryToken(String opcRetryToken)	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.
RestoreKeyFromFileRequest.Builder	restoreKeyFromFileDetails(InputStream restoreKeyFromFileDetails)	The encrypted backup file to upload to restore the key.
RestoreKeyFromFileRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.

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

contentLength

public RestoreKeyFromFileRequest.Builder contentLength(Long contentLength)

The content length of the body.

Parameters:

contentLength - the value to set

Returns:

this builder instance

restoreKeyFromFileDetails

public RestoreKeyFromFileRequest.Builder restoreKeyFromFileDetails(InputStream restoreKeyFromFileDetails)

The encrypted backup file to upload to restore the key.

Parameters:

restoreKeyFromFileDetails - the value to set

Returns:

this builder instance

ifMatch

public RestoreKeyFromFileRequest.Builder ifMatch(String ifMatch)

For optimistic concurrency control.

In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

Parameters:

ifMatch - the value to set

Returns:

this builder instance

contentMd5

public RestoreKeyFromFileRequest.Builder contentMd5(String contentMd5)

The base64-encoded MD5 hash value of the body, as described in RFC 2616, section 14.15.

If the Content-MD5 header is present, Key Management 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 don’t match, the object is rejected and a response with 400 Unmatched Content MD5 error is returned, along 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

opcRequestId

public RestoreKeyFromFileRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

opcRetryToken

public RestoreKeyFromFileRequest.Builder opcRetryToken(String opcRetryToken)

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Parameters:

opcRetryToken - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<RestoreKeyFromFileRequest,InputStream>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public RestoreKeyFromFileRequest build()

Build the instance of RestoreKeyFromFileRequest 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<RestoreKeyFromFileRequest,InputStream>

Returns:

instance of RestoreKeyFromFileRequest

body$

public RestoreKeyFromFileRequest.Builder body$(InputStream body)

Alternative setter for the body parameter.

Specified by:

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

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public RestoreKeyFromFileRequest buildWithoutInvocationCallback()

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