Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  val apiPrefix: String

   Attributes

   protected

   Definition Classes

   FileApi → HttpSupport

5.  val apiToken: Option[String]

   Attributes

   protected

   Definition Classes

   FileApi → HttpSupport

6.  val apiVersion: Option[String]

   Attributes

   protected

   Definition Classes

   FileApi → HttpSupport

7.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

8.  val baseUrl: URI

   Attributes

   protected

   Definition Classes

   FileApi → HttpSupport

9.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

10.  val connectionTimeout: Int

    Attributes

    protected

    Definition Classes

    FileApi → HttpSupport

11.  def debug(msg: String)(implicit enclosing: Name): Unit

    Definition Classes

    DebugEnhancedLogging

12.  def deleteAtTarget[D](endPoint: String)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

13.  def deletePath[D](subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    HttpSupport

14.  def deleteProvenanceJson(): Try[DataverseResponse[Any]]
    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#delete-provenance-json-for-an-uploaded-file

15.  def editVariableMetadata(ddiXml: Elem): Try[DataverseResponse[Any]]
    ddiXml

    DDI xml

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#editing-variable-level-metadata

16.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

17.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

18.  val extraHeaders: Map[String, String]

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

19.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

20.  def get[D](subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    HttpSupport

21.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

22.  def getMetadata: Try[FileMeta]

    Note: for some reason, the Dataverse's response is not wrapped in the usual envelope here.

    Note: for some reason, the Dataverse's response is not wrapped in the usual envelope here.

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#getting-file-metadata

23.  def getProvenanceDescription: Try[DataverseResponse[Any]]

    Returns free-form provenance.

    Returns free-form provenance.

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#get-provenance-description-for-an-uploaded-file

24.  def getProvenanceJson: Try[DataverseResponse[Any]]

    Returns JSON-based provenance.

    Returns JSON-based provenance.

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#get-provenance-json-for-an-uploaded-file

25.  def getUnversionedFromTarget[D](endPoint: String, queryParams: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Get something for which versions do not apply

    Get something for which versions do not apply

    D

    the type of model object to expect in the response message

    endPoint

    the API endpoint

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

26.  def getUnwrapped(subPath: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty): Try[HttpResponse[Array[Byte]]]

    Attributes

    protected

    Definition Classes

    HttpSupport

27.  def getUnwrappedFromTarget(endPoint: String, queryParams: Map[String, String] = Map.empty): Try[HttpResponse[Array[Byte]]]

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

28.  def getVersionedFromTarget[D](endPoint: String, version: Version = Version.LATEST)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Get a specific version of something.

    Get a specific version of something.

    D

    the type of model object to expect in the response message

    endPoint

    the API endpoint

    version

    the version or version label

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

29.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

30.  val id: String

    Attributes

    protected

    Definition Classes

    FileApi → TargetedHttpSupport

31.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

32.  val isPersistentId: Boolean

    Attributes

    protected

    Definition Classes

    FileApi → TargetedHttpSupport

33.  lazy val logger: Logger

    Attributes

    protected

    Definition Classes

    LazyLogging

    Annotations

    @transient()

34.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

35.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

36.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

37.  def postFile[D](subPath: String, optFile: Option[File], optJsonMetadata: Option[String] = Option.empty, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Posts a multi-part message with an optional file and optional JSON metadata part.

    Posts a multi-part message with an optional file and optional JSON metadata part. Probably at least one is required, but since this is an internal function, this is not validated.

    D

    the payload type for the DataverseResponse

    subPath

    subpath to post to

    optFile

    the optional file

    optJsonMetadata

    the optional metadata

    headers

    extra headers

    params

    extra query parameters

    returns

    a DataverseResponse

    Attributes

    protected

    Definition Classes

    HttpSupport

38.  def postFileToTarget[D](endPoint: String, optFile: Option[File], optMetadata: Option[String], queryParams: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

39.  def postJson[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty, isJsonLd: Boolean = false)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    HttpSupport

40.  def postJsonToTarget[D](endPoint: String, body: String, queryParams: Map[String, String] = Map.empty, headers: Map[String, String] = Map.empty, isJsonLd: Boolean = false)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

41.  def postText[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    HttpSupport

42.  def put[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    HttpSupport

43.  def putJson[D](subPath: String = null, body: String = null, headers: Map[String, String] = Map.empty, params: Map[String, String] = Map.empty, isJsonLd: Boolean = false)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    HttpSupport

44.  def putJsonToTarget[D](endPoint: String, body: String, queryParams: Map[String, String] = Map.empty, isJsonLd: Boolean = false)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

45.  def putProvenanceDescription(p: String): Try[DataverseResponse[Any]]

    Sets free-form provenance.

    Sets free-form provenance.

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#create-update-provenance-description-for-an-uploaded-file

46.  def putProvenanceJson(p: Provenance): Try[DataverseResponse[Any]]

    Sets JSON-based provenance.

    Sets JSON-based provenance.

    p

    provenance to set

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#create-update-provenance-json-and-provide-related-entity-name-for-an-uploaded-file

47.  def putToTarget[D](endPoint: String, body: String, queryParams: Map[String, String] = Map.empty)(implicit arg0: Manifest[D]): Try[DataverseResponse[D]]

    Attributes

    protected

    Definition Classes

    TargetedHttpSupport

48.  val readTimeout: Int

    Attributes

    protected

    Definition Classes

    FileApi → HttpSupport

49.  def redetect(dryRun: Boolean = false): Try[DataverseResponse[DetectionResult]]
    dryRun

    do not save the change

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#redetect-file-type

50.  def reingest(): Try[DataverseResponse[DataMessage]]
    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#reingest-a-file

51.  def replace(optDataFile: Option[File] = Option.empty, optFileMetadata: Option[FileMeta] = Option.empty): Try[DataverseResponse[FileList]]
    optDataFile

    the replacement file

    optFileMetadata

    the replacement metadata

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#replacing-files

52.  def replaceFileItem(optDataFile: Option[File] = Option.empty, optFileMetadata: Option[String] = Option.empty): Try[DataverseResponse[FileList]]
    optDataFile

    the replacement file

    optFileMetadata

    the replacement metadata

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#replacing-files

53.  def replaceWithPrestagedFile(prestagedFile: PrestagedFile): Try[DataverseResponse[FileList]]

    Replaces a file with a pre-staged file.

    Replaces a file with a pre-staged file.

    prestagedFile

    metadata about the prestaged file

    See also

    https://guides.dataverse.org/en/latest/developers/s3-direct-upload-api.html#replacing-an-existing-file-in-the-dataset

54.  def restrict(restrict: Boolean): Try[DataverseResponse[DataMessage]]
    restrict

    true if the file must have restricted access, false for open access

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#restrict-files

55.  val sendApiTokenViaBasicAuth: Boolean

    Attributes

    protected

    Definition Classes

    FileApi → HttpSupport

56.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

57.  val targetBase: String

    Attributes

    protected

    Definition Classes

    FileApi → TargetedHttpSupport

58.  def toString(): String

    Definition Classes

    AnyRef → Any

59.  def trace[V](value: Text[V])(implicit enclosing: Name): Unit

    Definition Classes

    DebugEnhancedLogging

60.  val unblockKey: Option[String]

    Attributes

    protected

    Definition Classes

    FileApi → HttpSupport

61.  def uningest(): Try[DataverseResponse[DataMessage]]
    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#uningest-a-file

62.  def updateMetadata(fm: FileMeta): Try[DataverseResponse[Nothing]]

    Unfortunately, the body of the response is not valid JSON, hence the Nothing payload type.

    Unfortunately, the body of the response is not valid JSON, hence the Nothing payload type.

    fm

    file metadata

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#updating-file-metadata

63.  def updateMetadata(fm: String): Try[DataverseResponse[Nothing]]

    Unfortunately, the body of the response is not valid JSON, hence the Nothing payload type.

    Unfortunately, the body of the response is not valid JSON, hence the Nothing payload type.

    fm

    file metadata

    See also

    https://guides.dataverse.org/en/latest/api/native-api.html#updating-file-metadata

64.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

65.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

66.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()