Package com.ibm.cloud.ibm_key_protect_api.v2.model

Class GetKeyVersionsOptions

java.lang.Object

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

com.ibm.cloud.ibm_key_protect_api.v2.model.GetKeyVersionsOptions

All Implemented Interfaces:

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

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

The getKeyVersions options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Boolean	allKeyStates()	Gets the allKeyStates.
String	bluemixInstance()	Gets the bluemixInstance.
String	correlationId()	Gets the correlationId.
String	id()	Gets the id.
Long	limit()	Gets the limit.
GetKeyVersionsOptions.Builder	newBuilder()	New builder.
Long	offset()	Gets the offset.
Boolean	totalCount()	Gets the totalCount.
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 GetKeyVersionsOptions.Builder newBuilder()

New builder.

Returns:

a GetKeyVersionsOptions builder

id

public String id()

Gets the id. The v4 UUID or alias that uniquely identifies the key.

Returns:

the id

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

xKmsKeyRing

public String xKmsKeyRing()

Gets the xKmsKeyRing. The ID of the key ring that the specified key is a part of. When the header is not specified, Key Protect will perform a key ring lookup. For a more optimized request, specify the key ring on every call. The key ring ID of keys that are created without an `X-Kms-Key-Ring` header is: `default`.

Returns:

the xKmsKeyRing

limit

public Long limit()

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

Returns:

the limit

offset

public Long offset()

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

Returns:

the offset

totalCount

public Boolean totalCount()

Gets the totalCount. If set to `true`, returns `totalCount` in the response metadata for use with pagination. The `totalCount` value returned specifies the total number of key versions that match the request, disregarding limit and offset. The default is set to false. **Usage:** To return the `totalCount` value for use with pagination, use `../versions?totalCount=true`.

Returns:

the totalCount

allKeyStates

public Boolean allKeyStates()

Gets the allKeyStates. If set to `true`, returns the key versions of a key in any state. **Usage:** If you have deleted a key and still want to retrieve its key versions use `../versions?allKeyStates=true`.

Returns:

the allKeyStates