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

Class ListSecretsLocksOptions

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

    • Method Detail

      • offset

        public Long offset()
        Gets the offset. The number of secrets 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 secrets in your instance, and you want to retrieve secrets 26 through 50, use `..?offset=25&limit=25`.
        Returns:
        the offset

      • limit

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

      • 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

      • groups

        public List<String> groups()
        Gets the groups. Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the `default` keyword. **Usage:** To retrieve a list of secrets that are associated with an existing secret group or the default group, use `..?groups={secret_group_ID},default`.
        Returns:
        the groups