SAP AI SDK for JavaScript - v2.17.0
    Preparing search index...

    Variable DataDestinationsApiConst

    DataDestinationsApi: {
        _defaultBasePath: string;
        createUpdateDataDestination: (
            dataDestinationName: string,
            body: CreateDataDestination,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<AsyncCreateDataDestinationResponse>;
        deleteDataDestinationByName: (
            dataDestinationName: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<any>;
        getAllDataDestinations: (
            queryParameters: { $count?: boolean; $skip?: number; $top?: number },
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<GetDataDestinations>;
        getDataDestinationByName: (
            dataDestinationName: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<GetDataDestination>;
        patchDataDestinationByName: (
            dataDestinationName: string,
            body: PatchDataDestination,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<any>;
        searchDestinations: (
            body: { labels: Labels } & Record<string, any>,
            queryParameters: { $count?: boolean; $skip?: number; $top?: number },
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<GetDataDestinations>;
        validateDataDestination: (
            body: ValidateDataDestinationRequest,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<ValidateDataDestinationResponse>;
        validateDataDestinationByName: (
            dataDestinationName: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<ValidateDataDestinationResponse>;
    }

    Representation of the 'DataDestinationsApi'. This API is part of the 'context-registry' service.

    Type Declaration

    • _defaultBasePath: string
    • createUpdateDataDestination: (
          dataDestinationName: string,
          body: CreateDataDestination,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<AsyncCreateDataDestinationResponse>

      Create a data destination asynchronously. Schema validation happens synchronously; credential validation and secret storage run in a background task. Poll GET /dataDestinations/{name} to track progress via status and errorMessage. Returns 202 (not exists or ERROR retry), 409 (ACTIVE or DELETING), 422 (retry exhausted).

    • deleteDataDestinationByName: (
          dataDestinationName: string,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<any>

      Mark the data destination for deletion. Synchronously checks for dependent TabularArtifacts; returns 202 immediately after marking DELETING. The cron reaper handles secret deletion and hard delete.

    • getAllDataDestinations: (
          queryParameters: { $count?: boolean; $skip?: number; $top?: number },
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<GetDataDestinations>

      Get all data destinations in the tenant (resource group)

    • getDataDestinationByName: (
          dataDestinationName: string,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<GetDataDestination>

      Get metadata of a specific data destination (excluding credentials)

    • patchDataDestinationByName: (
          dataDestinationName: string,
          body: PatchDataDestination,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<any>

      Update a data destination (excluding name and type)

    • searchDestinations: (
          body: { labels: Labels } & Record<string, any>,
          queryParameters: { $count?: boolean; $skip?: number; $top?: number },
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<GetDataDestinations>

      Search data destinations by label key-value pairs

    • validateDataDestination: (
          body: ValidateDataDestinationRequest,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<ValidateDataDestinationResponse>

      Test provider connectivity before saving. Nothing is persisted.

    • validateDataDestinationByName: (
          dataDestinationName: string,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<ValidateDataDestinationResponse>

      Re-verify an already-saved destination using stored credentials.