com.oracle.bmc.keymanagement.requests

Class ListKeysRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.keymanagement.requests.ListKeysRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public class ListKeysRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListKeysRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListKeysRequest.Algorithm The algorithm used by a key’s key versions to encrypt or decrypt.
static class	ListKeysRequest.Builder
static class	ListKeysRequest.CurveId The curve Id of the keys in case of ECDSA keys
static class	ListKeysRequest.ProtectionMode A key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
static class	ListKeysRequest.SortBy The field to sort by.
static class	ListKeysRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Method Summary

Modifier and Type	Method and Description
static ListKeysRequest.Builder	builder()
ListKeysRequest.Algorithm	getAlgorithm() The algorithm used by a key’s key versions to encrypt or decrypt.
String	getCompartmentId() The OCID of the compartment.
ListKeysRequest.CurveId	getCurveId() The curve Id of the keys in case of ECDSA keys
Integer	getLength() The length of the key in bytes, expressed as an integer.
Integer	getLimit() The maximum number of items to return in a paginated "List" call.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() The value of the opc-next-page response header from the previous "List" call.
ListKeysRequest.ProtectionMode	getProtectionMode() A key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
ListKeysRequest.SortBy	getSortBy() The field to sort by.
ListKeysRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ListKeysRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getLimit

public Integer getLimit()

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

getPage

public String getPage()

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

getOpcRequestId

public String getOpcRequestId()

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.

getSortBy

public ListKeysRequest.SortBy getSortBy()

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.

getSortOrder

public ListKeysRequest.SortOrder getSortOrder()

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

getProtectionMode

public ListKeysRequest.ProtectionMode getProtectionMode()

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.

getAlgorithm

public ListKeysRequest.Algorithm getAlgorithm()

The algorithm used by a key’s key versions to encrypt or decrypt. Currently, only AES, RSA and ECDSA are supported.

getLength

public Integer getLength()

The length of the key in bytes, expressed as an integer. Values of 16, 24, 32 are supported.

getCurveId

public ListKeysRequest.CurveId getCurveId()

The curve Id of the keys in case of ECDSA keys