Package org.opendatadiscovery.oddplatform.ingestion.contract.api

Interface IngestionApi

  • @Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2022-10-13T09:13:20.105369Z[Etc/UTC]")
@Validated
public interface IngestionApi

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<java.lang.Void>> createAlerts​(@Valid reactor.core.publisher.Mono<IngestionAlertList> ingestionAlertList, org.springframework.web.server.ServerWebExchange exchange)
      POST /ingestion/alerts Alerts target catalog about ingestion issues
      default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<java.lang.Void>> createDataSource​(@Valid reactor.core.publisher.Mono<DataSourceList> dataSourceList, org.springframework.web.server.ServerWebExchange exchange)
      POST /ingestion/datasources Creates data sources in the target catalog
      default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CompactDataEntityList>> getDataEntitiesByDEGOddrn​(@NotNull @Valid java.lang.String oddrn, org.springframework.web.server.ServerWebExchange exchange)
      GET /ingestion/entities/degs/children Searches for data entities in the target catalog by oddrn of a DEG they are currently part of
      default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<java.lang.Void>> postDataEntityList​(@Valid reactor.core.publisher.Mono<DataEntityList> dataEntityList, org.springframework.web.server.ServerWebExchange exchange)
      POST /ingestion/entities Ingests list of data entities
      default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<java.lang.Void>> postDataSetStatsList​(@Valid reactor.core.publisher.Mono<DatasetStatisticsList> datasetStatisticsList, org.springframework.web.server.ServerWebExchange exchange)
      POST /ingestion/entities/datasets/stats Ingests list of stats for data sets

    • Method Detail

      • createAlerts

        @PostMapping(value="/ingestion/alerts",
             consumes="application/json")
default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<java.lang.Void>> createAlerts​(@Valid @RequestBody(required=false)
                                                                                                          @Valid reactor.core.publisher.Mono<IngestionAlertList> ingestionAlertList,
                                                                                                          org.springframework.web.server.ServerWebExchange exchange)
        POST /ingestion/alerts Alerts target catalog about ingestion issues
        Parameters:
        ingestionAlertList - (optional)
        Returns:
        Created (status code 201)

      • createDataSource

        @PostMapping(value="/ingestion/datasources",
             consumes="application/json")
default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<java.lang.Void>> createDataSource​(@Valid @RequestBody(required=false)
                                                                                                              @Valid reactor.core.publisher.Mono<DataSourceList> dataSourceList,
                                                                                                              org.springframework.web.server.ServerWebExchange exchange)
        POST /ingestion/datasources Creates data sources in the target catalog
        Parameters:
        dataSourceList - (optional)
        Returns:
        Created (status code 201)

      • getDataEntitiesByDEGOddrn

        @GetMapping(value="/ingestion/entities/degs/children",
            produces="application/json")
default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CompactDataEntityList>> getDataEntitiesByDEGOddrn​(@NotNull @Valid @RequestParam(value="oddrn",required=true)
                                                                                                                              @NotNull @Valid java.lang.String oddrn,
                                                                                                                              org.springframework.web.server.ServerWebExchange exchange)
        GET /ingestion/entities/degs/children Searches for data entities in the target catalog by oddrn of a DEG they are currently part of
        Parameters:
        oddrn - (required)
        Returns:
        OK (status code 200)

      • postDataEntityList

        @PostMapping(value="/ingestion/entities",
             consumes="application/json")
default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<java.lang.Void>> postDataEntityList​(@Valid @RequestBody
                                                                                                                @Valid reactor.core.publisher.Mono<DataEntityList> dataEntityList,
                                                                                                                org.springframework.web.server.ServerWebExchange exchange)
        POST /ingestion/entities Ingests list of data entities
        Parameters:
        dataEntityList - (required)
        Returns:
        Created (status code 201)

      • postDataSetStatsList

        @PostMapping(value="/ingestion/entities/datasets/stats",
             consumes="application/json")
default reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<java.lang.Void>> postDataSetStatsList​(@Valid @RequestBody
                                                                                                                  @Valid reactor.core.publisher.Mono<DatasetStatisticsList> datasetStatisticsList,
                                                                                                                  org.springframework.web.server.ServerWebExchange exchange)
        POST /ingestion/entities/datasets/stats Ingests list of stats for data sets
        Parameters:
        datasetStatisticsList - (required)
        Returns:
        Created (status code 201)