IDataSourceDefinition
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Full definition of a data source used to create it or to replace it.
export interface IDataSourceDefinition
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) Use | ||
(ALPHA) (Optional) | |||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
DataSourceDateTimeSemantics | null | (ALPHA) (Optional) | ||
boolean | null | (ALPHA) (Optional) | ||
string | (ALPHA) | ||
boolean | null | (ALPHA) (Optional) Skip the audience check of JWT tokens in the OIDC authentication. | ||
string | (ALPHA) | ||
(ALPHA) (Optional) | |||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) | ||
string | (ALPHA) (Optional) | ||
(ALPHA) | |||
string | (ALPHA) (Optional) | ||
string | (ALPHA) (Optional) |
Property details
IDataSourceDefinition.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;
IDataSourceDefinition.authenticationTypepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
authenticationType?: DataSourceAuthenticationType | null;
IDataSourceDefinition.cacheRetentionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Use null to remove the cache retention policy of the data source.
cacheRetention?: DataSourceCacheRetention | null;
IDataSourceDefinition.cacheStrategypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
cacheStrategy?: DataSourceCacheStrategy;
IDataSourceDefinition.clientIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
clientId?: string;
IDataSourceDefinition.clientSecretpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
clientSecret?: string;
IDataSourceDefinition.dateTimeSemanticspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
dateTimeSemantics?: DataSourceDateTimeSemantics | null;
IDataSourceDefinition.disableStatisticspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
disableStatistics?: boolean | null;
IDataSourceDefinition.idpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
id: string;
IDataSourceDefinition.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;
IDataSourceDefinition.namepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
name: string;
IDataSourceDefinition.parameterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
parameters?: IDataSourceParameter[];
IDataSourceDefinition.passwordpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
password?: string;
IDataSourceDefinition.privateKeypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
privateKey?: string;
IDataSourceDefinition.privateKeyPassphrasepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
privateKeyPassphrase?: string;
IDataSourceDefinition.schemapropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
schema: string;
IDataSourceDefinition.tokenpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
token?: string;
IDataSourceDefinition.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
type: DataSourceType;
IDataSourceDefinition.urlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
url?: string;
IDataSourceDefinition.usernamepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
username?: string;