Package com.onshape.api.requests

Class PartStudiosGetSketchInfoRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosGetSketchInfoRequest.Builder

Enclosing class:

PartStudiosGetSketchInfoRequest

public static final class PartStudiosGetSketchInfoRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosGetSketchInfoResponse	call(OnshapeDocument document)	Calls getSketchInfo method, Get information for sketches in a part studio
PartStudiosGetSketchInfoResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getSketchInfo method, Get information for sketches in a part studio
String	configuration()	Get Configuration string
PartStudiosGetSketchInfoRequest.Builder	configuration(String value)	Set Configuration string
Boolean	curvePoints()	Get Whether or not to output start/quarter/mid/end points, start/end tangent vectors, and length of sketch curves
PartStudiosGetSketchInfoRequest.Builder	curvePoints(Boolean value)	Set Whether or not to output start/quarter/mid/end points, start/end tangent vectors, and length of sketch curves
Boolean	includeGeometry()	Get Whether or not to just output simple sketch info without geometry
PartStudiosGetSketchInfoRequest.Builder	includeGeometry(Boolean value)	Set Whether or not to just output simple sketch info without geometry
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosGetSketchInfoRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Boolean	output3D()	Get Whether or not to output with respect to global 3D coordinate system
PartStudiosGetSketchInfoRequest.Builder	output3D(Boolean value)	Set Whether or not to output with respect to global 3D coordinate system
String	sketchId()	Get ID of a sketch feature; repeat query param to add more than one.
PartStudiosGetSketchInfoRequest.Builder	sketchId(String value)	Set ID of a sketch feature; repeat query param to add more than one.

Methods inherited from class java.lang.Object

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

Method Detail

sketchId

public final String sketchId()

Get ID of a sketch feature; repeat query param to add more than one. If no sketchId query parameter is passed, all sketches in the part studio are returned.

Returns:

ID of a sketch feature; repeat query param to add more than one. If no sketchId query parameter is passed, all sketches in the part studio are returned.

sketchId

public final PartStudiosGetSketchInfoRequest.Builder sketchId(String value)

Set ID of a sketch feature; repeat query param to add more than one. If no sketchId query parameter is passed, all sketches in the part studio are returned.

Parameters:

value - ID of a sketch feature; repeat query param to add more than one. If no sketchId query parameter is passed, all sketches in the part studio are returned.

Returns:

the Builder object.

output3D

public final Boolean output3D()

Get Whether or not to output with respect to global 3D coordinate system

Returns:

Whether or not to output with respect to global 3D coordinate system

output3D

public final PartStudiosGetSketchInfoRequest.Builder output3D(Boolean value)

Set Whether or not to output with respect to global 3D coordinate system

Parameters:

value - Whether or not to output with respect to global 3D coordinate system

Returns:

the Builder object.

curvePoints

public final Boolean curvePoints()

Get Whether or not to output start/quarter/mid/end points, start/end tangent vectors, and length of sketch curves

Returns:

Whether or not to output start/quarter/mid/end points, start/end tangent vectors, and length of sketch curves

curvePoints

public final PartStudiosGetSketchInfoRequest.Builder curvePoints(Boolean value)

Set Whether or not to output start/quarter/mid/end points, start/end tangent vectors, and length of sketch curves

Parameters:

value - Whether or not to output start/quarter/mid/end points, start/end tangent vectors, and length of sketch curves

Returns:

the Builder object.

includeGeometry

public final Boolean includeGeometry()

Get Whether or not to just output simple sketch info without geometry

Returns:

Whether or not to just output simple sketch info without geometry

includeGeometry

public final PartStudiosGetSketchInfoRequest.Builder includeGeometry(Boolean value)

Set Whether or not to just output simple sketch info without geometry

Parameters:

value - Whether or not to just output simple sketch info without geometry

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

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls getSketchInfo method, Get information for sketches in a part studio

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 PartStudiosGetSketchInfoResponse call(OnshapeDocument document)
                                            throws OnshapeException

Calls getSketchInfo method, Get information for sketches in a part studio

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error