Package com.onshape.api.requests

Class PartsExportParasolidRequest.Builder

java.lang.Object

com.onshape.api.requests.PartsExportParasolidRequest.Builder

Enclosing class:

PartsExportParasolidRequest

public static final class PartsExportParasolidRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartsExportParasolidResponse	call(OnshapeDocument document, String partid)	Calls exportParasolid method, Export the part in text Parasolid format; returns a 307 redirect.
PartsExportParasolidResponse	call(String did, WVM wvmType, String wvm, String eid, String partid)	Calls exportParasolid method, Export the part in text Parasolid format; returns a 307 redirect.
InputStreamWithHeaders	callToStream(String did, WVM wvmType, String wvm, String eid, String partid)	Calls exportParasolid method, Export the part in text Parasolid format; returns a 307 redirect.
String	configuration()	Get Configuration string
PartsExportParasolidRequest.Builder	configuration(String value)	Set Configuration string
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartsExportParasolidRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Number	version()	Get Parasolid version
PartsExportParasolidRequest.Builder	version(Number value)	Set Parasolid version

Methods inherited from class java.lang.Object

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

Method Detail

version

public final Number version()

Get Parasolid version

Returns:

Parasolid version

version

public final PartsExportParasolidRequest.Builder version(Number value)

Set Parasolid version

Parameters:

value - Parasolid version

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 PartsExportParasolidRequest.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.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final PartsExportParasolidRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls exportParasolid method, Export the part in text Parasolid format; returns a 307 redirect.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

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

eid - Part studio element ID

partid - Part ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartsExportParasolidResponse call(OnshapeDocument document,
                                               String partid)
                                        throws OnshapeException

Calls exportParasolid method, Export the part in text Parasolid format; returns a 307 redirect.

Parameters:

document - Document object from Onshape URL.

partid - Part ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

callToStream

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

Calls exportParasolid method, Export the part in text Parasolid format; returns a 307 redirect.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

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

eid - Part studio element ID

partid - Part ID

Returns:

InputStreamWithHeaders stream with headers

Throws:

OnshapeException - On HTTP error