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

Class ListSecretsOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class ListSecretsOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The listSecrets 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

      • sort

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

      • search

        public String search()
        Gets the search. Obtain a collection of secrets that contain the specified string in one or more of the fields: `id`, `name`, `description`, `labels`, `secret_type`. **Usage:** If you want to list only the secrets that contain the string `text`, use `../secrets?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

      • secretTypes

        public List<String> secretTypes()
        Gets the secretTypes. Filter secrets by types. You can apply multiple filters by using a comma-separated list of secret types. **Usage:** To retrieve a list of imported certificates and public certificates use `..?secret_types=imported_cert,public_cert`.
        Returns:
        the secretTypes

      • matchAllLabels

        public List<String> matchAllLabels()
        Gets the matchAllLabels. Filter secrets by labels. You can use a comma-separated list of labels to filter secrets that include all of the labels in the list. **Usage:** To retrieve a list of secrets that include both the label "dev" and the label "us-south" in their list of labels, use `..?labels=dev,us-south`.
        Returns:
        the matchAllLabels