com.oracle.bmc.keymanagement.requests

Class ListKeysRequest.Builder

java.lang.Object

com.oracle.bmc.keymanagement.requests.ListKeysRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListKeysRequest,Void>

Enclosing class:

ListKeysRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListKeysRequest.Builder	algorithm(ListKeysRequest.Algorithm algorithm) The algorithm used by a key’s key versions to encrypt or decrypt data.
ListKeysRequest	build() Build the instance of ListKeysRequest as configured by this builder
ListKeysRequest	buildWithoutInvocationCallback() Build the instance of ListKeysRequest as configured by this builder
ListKeysRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment.
ListKeysRequest.Builder	copy(ListKeysRequest o) Copy method to populate the builder with values from the given instance.
ListKeysRequest.Builder	curveId(ListKeysRequest.CurveId curveId) The curve ID of the keys.
ListKeysRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListKeysRequest.Builder	length(Integer length) The length of the key in bytes, expressed as an integer.
ListKeysRequest.Builder	limit(Integer limit) The maximum number of items to return in a paginated “List” call.
ListKeysRequest.Builder	opcRequestId(String opcRequestId) Unique identifier for the request.
ListKeysRequest.Builder	page(String page) The value of the opc-next-page response header from the previous “List” call.
ListKeysRequest.Builder	protectionMode(ListKeysRequest.ProtectionMode protectionMode) A key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
ListKeysRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListKeysRequest.Builder	sortBy(ListKeysRequest.SortBy sortBy) The field to sort by.
ListKeysRequest.Builder	sortOrder(ListKeysRequest.SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).

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

compartmentId

public ListKeysRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

public ListKeysRequest.Builder limit(Integer limit)

The maximum number of items to return in a paginated “List” call.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListKeysRequest.Builder page(String page)

The value of the opc-next-page response header from the previous “List” call.

Parameters:

page - the value to set

Returns:

this builder instance

opcRequestId

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

sortBy

public ListKeysRequest.Builder sortBy(ListKeysRequest.SortBy sortBy)

The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListKeysRequest.Builder sortOrder(ListKeysRequest.SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

protectionMode

public ListKeysRequest.Builder protectionMode(ListKeysRequest.ProtectionMode protectionMode)

A key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault’s RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. A protection mode of EXTERNAL mean that the key persists on the customer’s external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.

Parameters:

protectionMode - the value to set

Returns:

this builder instance

algorithm

public ListKeysRequest.Builder algorithm(ListKeysRequest.Algorithm algorithm)

The algorithm used by a key’s key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms.

Parameters:

algorithm - the value to set

Returns:

this builder instance

length

public ListKeysRequest.Builder length(Integer length)

The length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32.

Parameters:

length - the value to set

Returns:

this builder instance

curveId

public ListKeysRequest.Builder curveId(ListKeysRequest.CurveId curveId)

The curve ID of the keys. (This pertains only to ECDSA keys.)

Parameters:

curveId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListKeysRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListKeysRequest build()

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

Returns:

instance of ListKeysRequest

buildWithoutInvocationCallback

public ListKeysRequest buildWithoutInvocationCallback()

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