Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListSettingsOptions

Package version

Common options for 'list' style APIs in AppConfig used to specify wildcards as well as the accept date time header.

Hierarchy

Index

Properties

Properties

Optional acceptDateTime

acceptDateTime: Date

Requests the server to respond with the state of the resource at the specified time.

Optional fields

fields: ("key" | "label" | "value" | "tags" | "etag" | "contentType" | "isReadOnly" | "lastModified")[]

Which fields to return for each ConfigurationSetting

Optional keyFilter

keyFilter: undefined | string

Filters for keys. There are two types of matching:

  1. Exact matching. Up to 5 key names are allowed, separated by commas (',')

  2. Wildcard matching. A single wildcard expression can be specified.

    Value Matches
    omitted or * Matches any key
    abc Matches a key named abc
    abc* Matches key names that start with abc

These characters are reserved and must be prefixed with backslash in order to be specified: * or \ or ,

Optional labelFilter

labelFilter: undefined | string

Filters for labels. There are two types of matching:

  1. Exact matching. Up to 5 labels are allowed, separated by commas (',')

  2. Wildcard matching. A single wildcard expression can be specified.

    Value Matches
    omitted or * Matches any key
    %00 Matches any key without a label
    prod Matches a key with label named prod
    prod* Matches key with label names that start with prod

These characters are reserved and must be prefixed with backslash in order to be specified: * or \ or ,

Generated using TypeDoc