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

Class GetKmipObjectsOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class GetKmipObjectsOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The getKmipObjects options.

    • Method Detail

      • 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 kmip objects to retrieve. By default, `GET /kmip_adapters/{id}/kmip_objects` returns the first 100 kmip_objects. To retrieve a different set of kmip objects, use `limit` with `offset` to page through your available resources. The maximum value for `limit` is 5000. **Usage:** If you have 20 kmip objects associated with your KMIP adapter, and you want to retrieve only the first 5 kmip objects, use `../kmip_adapters/{id}/kmip_objects?limit=5`.
        Returns:
        the limit

      • offset

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

      • state

        public List<Long> state()
        Gets the state. List of states to filter the KMIP objects on. The `default` is set to `[1,2,3,4]`. States are integers and correspond to Pre-Active = 1, Active = 2, Deactivated = 3, Compromised = 4, Destroyed = 5, Destroyed Compromised = 6. **Usage:** To filter on multiples `state` values, use `../kmip_adapters/{id}/kmip_objects?state=2,3`.
        Returns:
        the state

      • correlationId

        public String correlationId()
        Gets the correlationId. The v4 UUID used to correlate and track transactions.
        Returns:
        the correlationId