Package com.onshape.api.requests

Class PartsGetPartsRequest.Builder

java.lang.Object

com.onshape.api.requests.PartsGetPartsRequest.Builder

Enclosing class:

PartsGetPartsRequest

public static final class PartsGetPartsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartsGetPartsResponse	call(OnshapeDocument document)	Calls getParts method, Get list of parts
PartsGetPartsResponse	call(String did, WVM wvmType, String wvm)	Calls getParts method, Get list of parts
Boolean	includeFlatParts()	Get Whether or not to include flattened sheet metal parts
PartsGetPartsRequest.Builder	includeFlatParts(Boolean value)	Set Whether or not to include flattened sheet metal parts
Boolean	includePropertyDefaults()	Get If true, include metadata schema property defaults in response
PartsGetPartsRequest.Builder	includePropertyDefaults(Boolean value)	Set If true, include metadata schema property defaults in response
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartsGetPartsRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Boolean	withThumbnails()	Get Whether or not to include thumbnails (not supported for microversion)
PartsGetPartsRequest.Builder	withThumbnails(Boolean value)	Set Whether or not to include thumbnails (not supported for microversion)

Methods inherited from class java.lang.Object

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

Method Detail

withThumbnails

public final Boolean withThumbnails()

Get Whether or not to include thumbnails (not supported for microversion)

Returns:

Whether or not to include thumbnails (not supported for microversion)

withThumbnails

public final PartsGetPartsRequest.Builder withThumbnails(Boolean value)

Set Whether or not to include thumbnails (not supported for microversion)

Parameters:

value - Whether or not to include thumbnails (not supported for microversion)

Returns:

the Builder object.

includeFlatParts

public final Boolean includeFlatParts()

Get Whether or not to include flattened sheet metal parts

Returns:

Whether or not to include flattened sheet metal parts

includeFlatParts

public final PartsGetPartsRequest.Builder includeFlatParts(Boolean value)

Set Whether or not to include flattened sheet metal parts

Parameters:

value - Whether or not to include flattened sheet metal parts

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

includePropertyDefaults

public final Boolean includePropertyDefaults()

Get If true, include metadata schema property defaults in response

Returns:

If true, include metadata schema property defaults in response

includePropertyDefaults

public final PartsGetPartsRequest.Builder includePropertyDefaults(Boolean value)

Set If true, include metadata schema property defaults in response

Parameters:

value - If true, include metadata schema property defaults in response

Returns:

the Builder object.

call

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

Calls getParts method, Get list of parts

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

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

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartsGetPartsResponse call(OnshapeDocument document)
                                 throws OnshapeException

Calls getParts method, Get list of parts

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error