Package com.onshape.api.requests

Class BlobElementsDownloadFileFromElementRequest.Builder

java.lang.Object

com.onshape.api.requests.BlobElementsDownloadFileFromElementRequest.Builder

Enclosing class:

BlobElementsDownloadFileFromElementRequest

public static final class BlobElementsDownloadFileFromElementRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
BlobElementsDownloadFileFromElementResponse	call(OnshapeDocument document)	Calls downloadFileFromElement method, Download a file from a blob element
BlobElementsDownloadFileFromElementResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls downloadFileFromElement method, Download a file from a blob element
InputStreamWithHeaders	callToStream(String did, WVM wvmType, String wvm, String eid)	Calls downloadFileFromElement method, Download a file from a blob element
String	contentDisposition()	Get If "attachment", includes a Content-Disposition return header with the filename
BlobElementsDownloadFileFromElementRequest.Builder	contentDisposition(String value)	Set If "attachment", includes a Content-Disposition return header with the filename
String	linkDocumentId()	Get Id of document that links to the document being accessed.
BlobElementsDownloadFileFromElementRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

contentDisposition

public final String contentDisposition()

Get If "attachment", includes a Content-Disposition return header with the filename

Returns:

If "attachment", includes a Content-Disposition return header with the filename

contentDisposition

public final BlobElementsDownloadFileFromElementRequest.Builder contentDisposition(String value)

Set If "attachment", includes a Content-Disposition return header with the filename

Parameters:

value - If "attachment", includes a Content-Disposition return header with the filename

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final BlobElementsDownloadFileFromElementRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

call

public final BlobElementsDownloadFileFromElementResponse call(String did,
                                                              WVM wvmType,
                                                              String wvm,
                                                              String eid)
                                                       throws OnshapeException

Calls downloadFileFromElement method, Download a file from a blob element

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final BlobElementsDownloadFileFromElementResponse call(OnshapeDocument document)
                                                       throws OnshapeException

Calls downloadFileFromElement method, Download a file from a blob element

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

callToStream

public final InputStreamWithHeaders callToStream(String did,
                                                 WVM wvmType,
                                                 String wvm,
                                                 String eid)
                                          throws OnshapeException

Calls downloadFileFromElement method, Download a file from a blob element

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

Returns:

InputStreamWithHeaders stream with headers

Throws:

OnshapeException - On HTTP error