com.ibm.cloud.ibm_key_protect_api.v2.model

Class GetKeysOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.ibm_key_protect_api.v2.model.GetKeysOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class GetKeysOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The getKeys options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetKeysOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	bluemixInstance() Gets the bluemixInstance.
String	correlationId() Gets the correlationId.
Boolean	extractable() Gets the extractable.
Long	limit() Gets the limit.
GetKeysOptions.Builder	newBuilder() New builder.
Long	offset() Gets the offset.
List<Long>	state() Gets the state.
String	xKmsKeyRing() Gets the xKmsKeyRing.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public GetKeysOptions.Builder newBuilder()

New builder.

Returns:

a GetKeysOptions builder

bluemixInstance

public String bluemixInstance()

Gets the bluemixInstance. The IBM Cloud instance ID that identifies your Key Protect service instance.

Returns:

the bluemixInstance

correlationId

public String correlationId()

Gets the correlationId. The v4 UUID used to correlate and track transactions.

Returns:

the correlationId

limit

public Long limit()

Gets the limit. The number of keys to retrieve. By default, `GET /keys` returns the first 200 keys. To retrieve a different set of keys, use `limit` with `offset` to page through your available resources. The maximum value for `limit` is 5,000. **Usage:** If you have 20 keys in your instance, and you want to retrieve only the first 5 keys, use `../keys?limit=5`.

Returns:

the limit

offset

public Long offset()

Gets the offset. The number of keys to skip. By specifying `offset`, you retrieve a subset of keys that starts with the `offset` value. Use `offset` with `limit` to page through your available resources. **Usage:** If you have 100 keys in your instance, and you want to retrieve keys 26 through 50, use `../keys?offset=25&limit=25`.

Returns:

the offset

state

public List<Long> state()

Gets the state. The state of the keys to be retrieved. States must be a list of integers from 0 to 5 delimited by commas with no whitespace or trailing commas. Valid states are based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values. **Usage:** If you want to retrieve active and deleted keys, use `../keys?state=1,5`.

Returns:

the state

extractable

public Boolean extractable()

Gets the extractable. The type of keys to be retrieved. Filters keys based on the `extractable` property. You can use this query parameter to search for keys whose material can leave the service. If set to `true`, standard keys will be retrieved. If set to `false`, root keys will be retrieved. If omitted, both root and standard keys will be retrieved. **Usage:** If you want to retrieve standard keys, use `../keys?extractable=true`.

Returns:

the extractable

xKmsKeyRing

public String xKmsKeyRing()

Gets the xKmsKeyRing. The ID of the target key ring. If unspecified, all resources in the instance that the caller has access to will be returned. When the header is specified, only resources within the specified key ring, that the caller has access to, will be returned. The key ring ID of keys that are created without an `X-Kms-Key-Ring` header is: `default`.

Returns:

the xKmsKeyRing