Package com.ibm.cloud.secrets_manager_sdk.secrets_manager.v2.model

Class ListSecretVersionLocksOptions

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

    • Method Detail

      • secretId

        public String secretId()
        Gets the secretId. The UUID that uniquely identifies your secret.
        Returns:
        the secretId

      • id

        public String id()
        Gets the id. The UUID that uniquely identifies your secret version. You can use the `current` or `previous` aliases to refer to the current or previous secret version.
        Returns:
        the id

      • offset

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

      • limit

        public Long limit()
        Gets the limit. The number of locks with associated secret to retrieve. By default, list operations return the first 25 items. To retrieve a different set of items, use `limit` with `offset` to page through your available resources. **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5, use `..?limit=5`.
        Returns:
        the limit

      • sort

        public String sort()
        Gets the sort. Sort a collection of locks by the specified field in ascending order. To sort in descending order use the `-` character **Available values:** created_at | updated_at | name **Usage:** To sort a list of locks by their creation date, use `../locks?sort=created_at`.
        Returns:
        the sort

      • search

        public String search()
        Gets the search. Filter locks that contain the specified string in the field "name". **Usage:** If you want to list only the locks that contain the string "text" in the field "name", use `..?search=text`.
        Returns:
        the search