IDataSourceDescriptor
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Data source with its connection details. Secrets, such as passwords or tokens, are never included.
export interface IDataSourceDescriptor extends IDataSourceIdentifierDescriptor
Extends: IDataSourceIdentifierDescriptor
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | null | (ALPHA) (Optional) Identifier of the data source that the backend uses instead of this one. | ||
DataSourceAuthenticationType | null | (ALPHA) (Optional) | ||
DataSourceCacheRetention | null | (ALPHA) (Optional) | ||
DataSourceCacheStrategy | null | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
DataSourceDateTimeSemantics | null | (ALPHA) (Optional) | ||
IDataSourceParameter[] | null | (ALPHA) (Optional) | ||
boolean | null | (ALPHA) (Optional) | ||
boolean | null | (ALPHA) (Optional) Skip the audience check of JWT tokens in the OIDC authentication. | ||
IDataSourceParameter[] | null | (ALPHA) (Optional) | ||
(ALPHA) (Optional) | |||
string | null | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) |
Property details
IDataSourceDescriptor.alternativeDataSourceIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Identifier of the data source that the backend uses instead of this one.
alternativeDataSourceId?: string | null;
IDataSourceDescriptor.authenticationTypepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
authenticationType?: DataSourceAuthenticationType | null;
IDataSourceDescriptor.cacheRetentionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
cacheRetention?: DataSourceCacheRetention | null;
IDataSourceDescriptor.cacheStrategypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
cacheStrategy?: DataSourceCacheStrategy | null;
IDataSourceDescriptor.clientIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
clientId?: string;
IDataSourceDescriptor.dateTimeSemanticspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
dateTimeSemantics?: DataSourceDateTimeSemantics | null;
IDataSourceDescriptor.decodedParameterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
decodedParameters?: IDataSourceParameter[] | null;
IDataSourceDescriptor.disableStatisticspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
disableStatistics?: boolean | null;
IDataSourceDescriptor.ignoreJwtAudpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Skip the audience check of JWT tokens in the OIDC authentication.
ignoreJwtAud?: boolean | null;
IDataSourceDescriptor.parameterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
parameters?: IDataSourceParameter[] | null;
IDataSourceDescriptor.permissionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
permissions?: DataSourceUserPermission[];
IDataSourceDescriptor.urlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
url?: string | null;
IDataSourceDescriptor.usernamepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
username?: string;