Package com.onshape.api.requests

Class PartStudiosExportParasolidRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosExportParasolidRequest.Builder

Enclosing class:

PartStudiosExportParasolidRequest

public static final class PartStudiosExportParasolidRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosExportParasolidResponse	call(OnshapeDocument document)	Calls exportParasolid method, Export the part studio in text Parasolid format; returns a 307 redirect.
PartStudiosExportParasolidResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls exportParasolid method, Export the part studio in text Parasolid format; returns a 307 redirect.
InputStreamWithHeaders	callToStream(String did, WVM wvmType, String wvm, String eid)	Calls exportParasolid method, Export the part studio in text Parasolid format; returns a 307 redirect.
String	configuration()	Get Configuration string
PartStudiosExportParasolidRequest.Builder	configuration(String value)	Set Configuration string
Boolean	includeExportIds()	Get Whether topolgy ids should be exported as parasolid attributes
PartStudiosExportParasolidRequest.Builder	includeExportIds(Boolean value)	Set Whether topolgy ids should be exported as parasolid attributes
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosExportParasolidRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
String	partIds()	Get Comma-separated list of part IDs to export (omit to export entire part studio)
PartStudiosExportParasolidRequest.Builder	partIds(String value)	Set Comma-separated list of part IDs to export (omit to export entire part studio)
Number	version()	Get Parasolid version
PartStudiosExportParasolidRequest.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

partIds

public final String partIds()

Get Comma-separated list of part IDs to export (omit to export entire part studio)

Returns:

Comma-separated list of part IDs to export (omit to export entire part studio)

partIds

public final PartStudiosExportParasolidRequest.Builder partIds(String value)

Set Comma-separated list of part IDs to export (omit to export entire part studio)

Parameters:

value - Comma-separated list of part IDs to export (omit to export entire part studio)

Returns:

the Builder object.

version

public final Number version()

Get Parasolid version

Returns:

Parasolid version

version

public final PartStudiosExportParasolidRequest.Builder version(Number value)

Set Parasolid version

Parameters:

value - Parasolid version

Returns:

the Builder object.

includeExportIds

public final Boolean includeExportIds()

Get Whether topolgy ids should be exported as parasolid attributes

Returns:

Whether topolgy ids should be exported as parasolid attributes

includeExportIds

public final PartStudiosExportParasolidRequest.Builder includeExportIds(Boolean value)

Set Whether topolgy ids should be exported as parasolid attributes

Parameters:

value - Whether topolgy ids should be exported as parasolid attributes

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 PartStudiosExportParasolidRequest.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 PartStudiosExportParasolidRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls exportParasolid method, Export the part studio 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 - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartStudiosExportParasolidResponse call(OnshapeDocument document)
                                              throws OnshapeException

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

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 exportParasolid method, Export the part studio 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 - Element ID

Returns:

InputStreamWithHeaders stream with headers

Throws:

OnshapeException - On HTTP error