Package org.gbif.api.service.registry

Interface DatasetDataPackageService

public interface DatasetDataPackageService
Service interface for managing Dataset DataPackage metadata.

  • Method Details

    • create

      void create(UUID datasetKey, @NotNull @Valid Dataset.DataPackage dataPackage)
      Creates DataPackage metadata to a target dataset.
      Parameters:
      datasetKey - key of target dataset
      dataPackage - DataPackage metadata

    • update

      void update(UUID datasetKey, @NotNull @Valid Dataset.DataPackage dataPackage)
      Updates DataPackage metadata to a target dataset.
      Parameters:
      datasetKey - key of target dataset
      dataPackage - DataPackage metadata

    • get

      Dataset.DataPackage get(UUID datasetKey)
      Retrieves DataPackage metadata of a dataset.
      Parameters:
      datasetKey - key of target dataset

    • getResource

      String getResource(UUID datasetKey, String resourceName)
      Retrieves the resource metadata information of a dataset data package.
      Parameters:
      datasetKey - key of the dataset data package
      resourceName - resource name to retrieve
      Returns:
      JSON object as String

    • getResources

      String getResources(UUID datasetKey)
      Retrieves the list of resources for a dataset data package.
      Parameters:
      datasetKey - key of the dataset data package
      Returns:
      JSON object as String

    • getResourceNames

      List<String> getResourceNames(UUID datasetKey)
      Retrieves the list of resources names for a dataset data package.
      Parameters:
      datasetKey - key of the dataset data package
      Returns:
      JSON object as String

    • list

      PagingResponse<Dataset.DataPackage> list(PageableBase params)
      Retrieves a pageable response of the registered data packages.
      Parameters:
      params - pageable request
      Returns:
      paging response containing a list of data packages