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

Class ListConfigurationsOptions

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

    • Method Detail

      • offset

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

      • limit

        public Long limit()
        Gets the limit. The number of configurations 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 configurations in your instance, use `..?limit=25`.
        Returns:
        the limit

      • sort

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

      • search

        public String search()
        Gets the search. Obtain a collection of configurations that contain the specified string in one or more of the fields: `name`, `config_type`, `secret_type`. **Usage:** If you want to list only the configurations that contain the string `text`, use `../configurations?search=text`.
        Returns:
        the search

      • secretTypes

        public List<String> secretTypes()
        Gets the secretTypes. Filter configurations by secret types, iam_credentials, public_cert or private_cert. You can apply multiple filters by using a comma-separated list of secret types. **Usage:** To retrieve a list of configurations that are associated with all secret types, use `..?secret_types=iam_credentials,public_cert,private_cert,custom_credentials`.
        Returns:
        the secretTypes