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

Class GetKmipClientCertificatesOptions

java.lang.Object

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

com.ibm.cloud.ibm_key_protect_api.v2.model.GetKmipClientCertificatesOptions

All Implemented Interfaces:

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

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

The getKmipClientCertificates options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	adapterId()	Gets the adapterId.
String	bluemixInstance()	Gets the bluemixInstance.
String	correlationId()	Gets the correlationId.
Long	limit()	Gets the limit.
GetKmipClientCertificatesOptions.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 GetKmipClientCertificatesOptions.Builder newBuilder()

New builder.

Returns:

a GetKmipClientCertificatesOptions builder

adapterId

public String adapterId()

Gets the adapterId. The name or v4 UUID of the KMIP Adapter that uniquely identifies it.

Returns:

the adapterId

bluemixInstance

public String bluemixInstance()

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

Returns:

the bluemixInstance

limit

public Long limit()

Gets the limit. The number of client certificates to retrieve. By default, `GET /kmip_adapters/{id}/certificates` returns the first 100 certificates. To retrieve a different set of certificates, use `limit` with `offset` to page through your available resources. The maximum value for `limit` is 200. **Usage:** If you have 20 certificates associated with your KMIP adapter, and you want to retrieve only the first 5 certificates, use `../kmip_adapters/{id}/certificates?limit=5`.

Returns:

the limit

offset

public Long offset()

Gets the offset. The number of client certificates to skip. By specifying `offset`, you retrieve a subset of certificates that starts with the `offset` value. Use `offset` with `limit` to page through your available resources. **Usage:** If you have 20 certificates associated with your KMIP adapter, and you want to retrieve certificates 11 through 15, use `../kmip_adapters/{id}/certificates?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 client certificates 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/{id}/certificates?totalCount=true`.

Returns:

the totalCount

correlationId

public String correlationId()

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

Returns:

the correlationId