Package com.onshape.api.requests

Class PartsExportStlRequest.Builder

java.lang.Object

com.onshape.api.requests.PartsExportStlRequest.Builder

Enclosing class:

PartsExportStlRequest

public static final class PartsExportStlRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Number	angleTolerance()	Get Angle tolerance (in radians; must be < pi/2)
PartsExportStlRequest.Builder	angleTolerance(Number value)	Set Angle tolerance (in radians; must be < pi/2)
PartsExportStlResponse	call(OnshapeDocument document, String partid)	Calls exportStl method, Export the part in text or binary STL format; returns a 307 redirect.
PartsExportStlResponse	call(String did, WVM wvmType, String wvm, String eid, String partid)	Calls exportStl method, Export the part in text or binary STL format; returns a 307 redirect.
InputStreamWithHeaders	callToStream(String did, WVM wvmType, String wvm, String eid, String partid)	Calls exportStl method, Export the part in text or binary STL format; returns a 307 redirect.
Number	chordTolerance()	Get Chord tolerance (in selected units)
PartsExportStlRequest.Builder	chordTolerance(Number value)	Set Chord tolerance (in selected units)
String	configuration()	Get Configuration string
PartsExportStlRequest.Builder	configuration(String value)	Set Configuration string
Boolean	grouping()	Get Whether parts should be exported as a group or individually in a .zip file
PartsExportStlRequest.Builder	grouping(Boolean value)	Set Whether parts should be exported as a group or individually in a .zip file
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartsExportStlRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Number	maxFacetWidth()	Get Maximum facet width (in selected units)
PartsExportStlRequest.Builder	maxFacetWidth(Number value)	Set Maximum facet width (in selected units)
Number	minFacetWidth()	Get Minimum facet width (in selected units - must be < maximumFacetWidth)
PartsExportStlRequest.Builder	minFacetWidth(Number value)	Set Minimum facet width (in selected units - must be < maximumFacetWidth)
String	mode()	Get Type of file: text, binary
PartsExportStlRequest.Builder	mode(String value)	Set Type of file: text, binary
Number	scale()	Get Scale for measurements
PartsExportStlRequest.Builder	scale(Number value)	Set Scale for measurements
String	units()	Get Name of base unit (meter, centimeter, millimeter, inch, foot, or yard)
PartsExportStlRequest.Builder	units(String value)	Set Name of base unit (meter, centimeter, millimeter, inch, foot, or yard)

Methods inherited from class java.lang.Object

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

Method Detail

grouping

public final Boolean grouping()

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

Returns:

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

grouping

public final PartsExportStlRequest.Builder grouping(Boolean value)

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

Parameters:

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

Returns:

the Builder object.

scale

public final Number scale()

Get Scale for measurements

Returns:

Scale for measurements

scale

public final PartsExportStlRequest.Builder scale(Number value)

Set Scale for measurements

Parameters:

value - Scale for measurements

Returns:

the Builder object.

units

public final String units()

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

Returns:

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

units

public final PartsExportStlRequest.Builder units(String value)

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

Parameters:

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

Returns:

the Builder object.

angleTolerance

public final Number angleTolerance()

Get Angle tolerance (in radians; must be < pi/2)

Returns:

Angle tolerance (in radians; must be < pi/2)

angleTolerance

public final PartsExportStlRequest.Builder angleTolerance(Number value)

Set Angle tolerance (in radians; must be < pi/2)

Parameters:

value - Angle tolerance (in radians; must be < pi/2)

Returns:

the Builder object.

chordTolerance

public final Number chordTolerance()

Get Chord tolerance (in selected units)

Returns:

Chord tolerance (in selected units)

chordTolerance

public final PartsExportStlRequest.Builder chordTolerance(Number value)

Set Chord tolerance (in selected units)

Parameters:

value - Chord tolerance (in selected units)

Returns:

the Builder object.

maxFacetWidth

public final Number maxFacetWidth()

Get Maximum facet width (in selected units)

Returns:

Maximum facet width (in selected units)

maxFacetWidth

public final PartsExportStlRequest.Builder maxFacetWidth(Number value)

Set Maximum facet width (in selected units)

Parameters:

value - Maximum facet width (in selected units)

Returns:

the Builder object.

minFacetWidth

public final Number minFacetWidth()

Get Minimum facet width (in selected units - must be < maximumFacetWidth)

Returns:

Minimum facet width (in selected units - must be < maximumFacetWidth)

minFacetWidth

public final PartsExportStlRequest.Builder minFacetWidth(Number value)

Set Minimum facet width (in selected units - must be < maximumFacetWidth)

Parameters:

value - Minimum facet width (in selected units - must be < maximumFacetWidth)

Returns:

the Builder object.

mode

public final String mode()

Get Type of file: text, binary

Returns:

Type of file: text, binary

mode

public final PartsExportStlRequest.Builder mode(String value)

Set Type of file: text, binary

Parameters:

value - Type of file: text, binary

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

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls exportStl method, Export the part in text or binary STL 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 PartsExportStlResponse call(OnshapeDocument document,
                                         String partid)
                                  throws OnshapeException

Calls exportStl method, Export the part in text or binary STL 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 exportStl method, Export the part in text or binary STL 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