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

Class GetKmipAdaptersOptions

java.lang.Object

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

com.ibm.cloud.ibm_key_protect_api.v2.model.GetKmipAdaptersOptions

All Implemented Interfaces:

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

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

The getKmipAdapters options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	bluemixInstance()	Gets the bluemixInstance.
String	correlationId()	Gets the correlationId.
String	crkId()	Gets the crkId.
Long	limit()	Gets the limit.
GetKmipAdaptersOptions.Builder	newBuilder()	New builder.
Long	offset()	Gets the offset.
Boolean	totalCount()	Gets the totalCount.

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 GetKmipAdaptersOptions.Builder newBuilder()

New builder.

Returns:

a GetKmipAdaptersOptions 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 KMIP Adapters to retrieve. By default, `GET /kmip_adapters` returns the first 100 KMIP Adapters. To retrieve a different set of KMIP adapters, use `limit` with `offset` to page through your available resources. The maximum value for `limit` is 200. **Usage:** If you have 20 KMIP Adapters, and you want to retrieve only the first 5 adapters, use `../kmip_adapters?limit=5`.

Returns:

the limit

offset

public Long offset()

Gets the offset. The number of KMIP adapters to skip. By specifying `offset`, you retrieve a subset of KMIP adapters that starts with the `offset` value. Use `offset` with `limit` to page through your available resources. **Usage:** If you have 20 KMIP Adapters, and you want to retrieve adapters 11 through 15, use `../kmip_adapters?offset=10&limit=5`.

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 kmip adapters 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 `../kmip_adapters?totalCount=true`.

Returns:

the totalCount

crkId

public String crkId()

Gets the crkId. The root key ID(`crk_id`) in the `profile_data` to filter on. This field is currently only applicable to profile `"native_1.0"`. It will only return adapters with profile_data that contains this field. Example usage `../kmip_adapters?crk_id=feddecaf-0000-0000-0000-1234567890ab`.

Returns:

the crkId