Package com.onshape.api.requests

Class DocumentsExportElementPostJsonRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsExportElementPostJsonRequest.Builder

Enclosing class:

DocumentsExportElementPostJsonRequest

public static final class DocumentsExportElementPostJsonRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Number	angleTolerance()	Get Angle tolerance (must be < pi/2) (STL)
DocumentsExportElementPostJsonRequest.Builder	angleTolerance(Number value)	Set Angle tolerance (must be < pi/2) (STL)
DocumentsExportElementPostJsonResponse	call(OnshapeDocument document)	Calls exportElementPostJson method, Export the given element in STL or Parasolid (PS) formats; returns an URI in the response body, client should GET this URI to initiate the export.
DocumentsExportElementPostJsonResponse	call(String did, WV wvType, String wv, String eid)	Calls exportElementPostJson method, Export the given element in STL or Parasolid (PS) formats; returns an URI in the response body, client should GET this URI to initiate the export.
Number	chordTolerance()	Get Chord tolerance (STL)
DocumentsExportElementPostJsonRequest.Builder	chordTolerance(Number value)	Set Chord tolerance (STL)
String	format()	Get Export format: STL, PS
DocumentsExportElementPostJsonRequest.Builder	format(String value)	Set Export format: STL, PS
Boolean	grouping()	Get Whether parts should be exported as a group or individually in a .zip file (STL)
DocumentsExportElementPostJsonRequest.Builder	grouping(Boolean value)	Set Whether parts should be exported as a group or individually in a .zip file (STL)
String	linkDocumentId()	Get Id of document that links to the document being accessed.
DocumentsExportElementPostJsonRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
String	linkDocumentWorkspaceId()	Get The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.
DocumentsExportElementPostJsonRequest.Builder	linkDocumentWorkspaceId(String value)	Set The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.
Number	maxFacetWidth()	Get Maximum facet width (STL)
DocumentsExportElementPostJsonRequest.Builder	maxFacetWidth(Number value)	Set Maximum facet width (STL)
String	microversion()	Get Specified microversion for operation
DocumentsExportElementPostJsonRequest.Builder	microversion(String value)	Set Specified microversion for operation
Number	minFacetWidth()	Get Minimum facet width (must be < maximumFacetWidth) (STL)
DocumentsExportElementPostJsonRequest.Builder	minFacetWidth(Number value)	Set Minimum facet width (must be < maximumFacetWidth) (STL)
String	mode()	Get Type of file: text, binary (STL)
DocumentsExportElementPostJsonRequest.Builder	mode(String value)	Set Type of file: text, binary (STL)
String	partIds()	Get Comma-separated list of part IDs to export
DocumentsExportElementPostJsonRequest.Builder	partIds(String value)	Set Comma-separated list of part IDs to export
Number	scale()	Get Scale for measurements (STL)
DocumentsExportElementPostJsonRequest.Builder	scale(Number value)	Set Scale for measurements (STL)
Boolean	storeInDocument()	Get whether the output should be stored as a new element
DocumentsExportElementPostJsonRequest.Builder	storeInDocument(Boolean value)	Set whether the output should be stored as a new element
String	units()	Get Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)
DocumentsExportElementPostJsonRequest.Builder	units(String value)	Set Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)
Number	version()	Get Parasolid version (PS)
DocumentsExportElementPostJsonRequest.Builder	version(Number value)	Set Parasolid version (PS)
Boolean	zipSingleFileOutput()	Get Whether single file output should be returned as a .zip file (STL, grouping==true)
DocumentsExportElementPostJsonRequest.Builder	zipSingleFileOutput(Boolean value)	Set Whether single file output should be returned as a .zip file (STL, grouping==true)

Methods inherited from class java.lang.Object

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

Method Detail

format

public final String format()

Get Export format: STL, PS

Returns:

Export format: STL, PS

format

public final DocumentsExportElementPostJsonRequest.Builder format(String value)

Set Export format: STL, PS

Parameters:

value - Export format: STL, PS

Returns:

the Builder object.

storeInDocument

public final Boolean storeInDocument()

Get whether the output should be stored as a new element

Returns:

whether the output should be stored as a new element

storeInDocument

public final DocumentsExportElementPostJsonRequest.Builder storeInDocument(Boolean value)

Set whether the output should be stored as a new element

Parameters:

value - whether the output should be stored as a new element

Returns:

the Builder object.

linkDocumentWorkspaceId

public final String linkDocumentWorkspaceId()

Get The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.

Returns:

The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.

linkDocumentWorkspaceId

public final DocumentsExportElementPostJsonRequest.Builder linkDocumentWorkspaceId(String value)

Set The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.

Parameters:

value - The id of the workspace in which the result should be stored if storeInDocument is true and linkDocumentId is set.

Returns:

the Builder object.

partIds

public final String partIds()

Get Comma-separated list of part IDs to export

Returns:

Comma-separated list of part IDs to export

partIds

public final DocumentsExportElementPostJsonRequest.Builder partIds(String value)

Set Comma-separated list of part IDs to export

Parameters:

value - Comma-separated list of part IDs to export

Returns:

the Builder object.

microversion

public final String microversion()

Get Specified microversion for operation

Returns:

Specified microversion for operation

microversion

public final DocumentsExportElementPostJsonRequest.Builder microversion(String value)

Set Specified microversion for operation

Parameters:

value - Specified microversion for operation

Returns:

the Builder object.

grouping

public final Boolean grouping()

Get Whether parts should be exported as a group or individually in a .zip file (STL)

Returns:

Whether parts should be exported as a group or individually in a .zip file (STL)

grouping

public final DocumentsExportElementPostJsonRequest.Builder grouping(Boolean value)

Set Whether parts should be exported as a group or individually in a .zip file (STL)

Parameters:

value - Whether parts should be exported as a group or individually in a .zip file (STL)

Returns:

the Builder object.

zipSingleFileOutput

public final Boolean zipSingleFileOutput()

Get Whether single file output should be returned as a .zip file (STL, grouping==true)

Returns:

Whether single file output should be returned as a .zip file (STL, grouping==true)

zipSingleFileOutput

public final DocumentsExportElementPostJsonRequest.Builder zipSingleFileOutput(Boolean value)

Set Whether single file output should be returned as a .zip file (STL, grouping==true)

Parameters:

value - Whether single file output should be returned as a .zip file (STL, grouping==true)

Returns:

the Builder object.

scale

public final Number scale()

Get Scale for measurements (STL)

Returns:

Scale for measurements (STL)

scale

public final DocumentsExportElementPostJsonRequest.Builder scale(Number value)

Set Scale for measurements (STL)

Parameters:

value - Scale for measurements (STL)

Returns:

the Builder object.

units

public final String units()

Get Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)

Returns:

Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)

units

public final DocumentsExportElementPostJsonRequest.Builder units(String value)

Set Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)

Parameters:

value - Name of base unit: meter, centimeter, millimeter, inch, foot, yard (STL)

Returns:

the Builder object.

angleTolerance

public final Number angleTolerance()

Get Angle tolerance (must be < pi/2) (STL)

Returns:

Angle tolerance (must be < pi/2) (STL)

angleTolerance

public final DocumentsExportElementPostJsonRequest.Builder angleTolerance(Number value)

Set Angle tolerance (must be < pi/2) (STL)

Parameters:

value - Angle tolerance (must be < pi/2) (STL)

Returns:

the Builder object.

chordTolerance

public final Number chordTolerance()

Get Chord tolerance (STL)

Returns:

Chord tolerance (STL)

chordTolerance

public final DocumentsExportElementPostJsonRequest.Builder chordTolerance(Number value)

Set Chord tolerance (STL)

Parameters:

value - Chord tolerance (STL)

Returns:

the Builder object.

maxFacetWidth

public final Number maxFacetWidth()

Get Maximum facet width (STL)

Returns:

Maximum facet width (STL)

maxFacetWidth

public final DocumentsExportElementPostJsonRequest.Builder maxFacetWidth(Number value)

Set Maximum facet width (STL)

Parameters:

value - Maximum facet width (STL)

Returns:

the Builder object.

minFacetWidth

public final Number minFacetWidth()

Get Minimum facet width (must be < maximumFacetWidth) (STL)

Returns:

Minimum facet width (must be < maximumFacetWidth) (STL)

minFacetWidth

public final DocumentsExportElementPostJsonRequest.Builder minFacetWidth(Number value)

Set Minimum facet width (must be < maximumFacetWidth) (STL)

Parameters:

value - Minimum facet width (must be < maximumFacetWidth) (STL)

Returns:

the Builder object.

mode

public final String mode()

Get Type of file: text, binary (STL)

Returns:

Type of file: text, binary (STL)

mode

public final DocumentsExportElementPostJsonRequest.Builder mode(String value)

Set Type of file: text, binary (STL)

Parameters:

value - Type of file: text, binary (STL)

Returns:

the Builder object.

version

public final Number version()

Get Parasolid version (PS)

Returns:

Parasolid version (PS)

version

public final DocumentsExportElementPostJsonRequest.Builder version(Number value)

Set Parasolid version (PS)

Parameters:

value - Parasolid version (PS)

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 DocumentsExportElementPostJsonRequest.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 DocumentsExportElementPostJsonResponse call(String did,
                                                         WV wvType,
                                                         String wv,
                                                         String eid)
                                                  throws OnshapeException

Calls exportElementPostJson method, Export the given element in STL or Parasolid (PS) formats; returns an URI in the response body, client should GET this URI to initiate the export.

Parameters:

did - Document ID

wvType - Type of Workspace or Version

wv - Workspace (w) or Version (v) ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final DocumentsExportElementPostJsonResponse call(OnshapeDocument document)
                                                  throws OnshapeException

Calls exportElementPostJson method, Export the given element in STL or Parasolid (PS) formats; returns an URI in the response body, client should GET this URI to initiate the export.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error