ListFeatureFlagsOptions interface

Options for listFeatureFlags that allow for filtering based on name, label and tags.

Extends

Properties

acceptDateTime

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

fields

Which fields to return for each feature flag.

labelFilter

A filter for the label of the returned feature flags.

nameFilter

A filter for the name of the returned feature flags.

pageEtags

A list of page etags, one per page, used to conditionally retrieve pages. Each etag is sent as an If-None-Match header for its corresponding page; when the page is unchanged the service responds with 304 Not Modified and the SDK yields an empty page whose etag is preserved.

tagsFilter

A filter used to query by tags.

Inherited Properties

abortSignal

The signal which can be used to abort requests.

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

requestOptions

Options used when creating and sending HTTP requests for this operation.

serializerOptions

Options to override serialization/de-serialization behavior.

tracingOptions

Options used when tracing is enabled.

Property Details

acceptDateTime

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

acceptDateTime?: Date

Property Value

Date

fields

Which fields to return for each feature flag.

fields?: ("tags" | "description" | "lastModified" | (keyof FeatureFlagId) | "enabled" | "conditions" | "variants" | "allocation" | "telemetry")[]

Property Value

("tags" | "description" | "lastModified" | (keyof FeatureFlagId) | "enabled" | "conditions" | "variants" | "allocation" | "telemetry")[]

labelFilter

A filter for the label of the returned feature flags.

labelFilter?: string

Property Value

string

nameFilter

A filter for the name of the returned feature flags.

nameFilter?: string

Property Value

string

pageEtags

A list of page etags, one per page, used to conditionally retrieve pages. Each etag is sent as an If-None-Match header for its corresponding page; when the page is unchanged the service responds with 304 Not Modified and the SDK yields an empty page whose etag is preserved.

pageEtags?: string[]

Property Value

string[]

tagsFilter

A filter used to query by tags.

tagsFilter?: string[]

Property Value

string[]

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From OperationOptions.tracingOptions