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

Class GetRegistrationsAllKeysOptions

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

    • Method Detail

      • 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 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

      • urlEncodedResourceCrnQuery

        public String urlEncodedResourceCrnQuery()
        Gets the urlEncodedResourceCrnQuery. Filters for resources that are associated with a specified [Cloud Resource Name](/docs/account?topic=account-crn) (CRN) by using URL encoded wildcard characters (`*`). The parameter should contain all CRN segments and must be URL encoded. If provided, the parameter should not contain (`*`) in the first eight segments. If this parameter is not provided, registrations for all keys in the requested Key Protect instance are returned.
        Returns:
        the urlEncodedResourceCrnQuery

      • limit

        public Long limit()
        Gets the limit. The number of registrations to retrieve. By default returns the first 200 registrations. To retrieve a different set of registrations, use `limit` with `offset` to page through your available resources. The maximum value for `limit` is 5,000. **Usage:** If you have 20 registrations that are associated with a key, and you want to retrieve only the first 5 registrations, use `../registrations?limit=5`.
        Returns:
        the limit

      • offset

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

      • preventKeyDeletion

        public Boolean preventKeyDeletion()
        Gets the preventKeyDeletion. Filters registrations based on the `preventKeyDeletion` property. You can use this query parameter to search for registered cloud resources that are non-erasable due to a retention policy. This policy should only be set if a WORM policy (https://www.ibm.com/docs/en/spectrum-scale/5.0.1?topic=ics-how-write-once-read-many-worm-storage-works) must be satisfied. Do not set this policy by default. **Usage:** To search for registered cloud resources that have a retention policy, use `../registrations?preventKeyDeletion=true`.
        Returns:
        the preventKeyDeletion

      • 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 registrations that match the request, disregarding limit and offset. **Usage:** To return the `totalCount` value for use with pagination, use `../registrations?totalCount=true`.
        Returns:
        the totalCount