Package com.onshape.api.requests

Class AssembliesGetFeaturesRequest.Builder

java.lang.Object

com.onshape.api.requests.AssembliesGetFeaturesRequest.Builder

Enclosing class:

AssembliesGetFeaturesRequest

public static final class AssembliesGetFeaturesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AssembliesGetFeaturesResponse	call(OnshapeDocument document)	Calls getFeatures method, Get the definition of the feature list for an assembly
AssembliesGetFeaturesResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getFeatures method, Get the definition of the feature list for an assembly
String	featureId()	Get ID of a feature; repeat query param to add more than one
AssembliesGetFeaturesRequest.Builder	featureId(String value)	Set ID of a feature; repeat query param to add more than one
String	linkDocumentId()	Get Id of document that links to the document being accessed.
AssembliesGetFeaturesRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

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

Method Detail

featureId

public final String featureId()

Get ID of a feature; repeat query param to add more than one

Returns:

ID of a feature; repeat query param to add more than one

featureId

public final AssembliesGetFeaturesRequest.Builder featureId(String value)

Set ID of a feature; repeat query param to add more than one

Parameters:

value - ID of a feature; repeat query param to add more than one

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 AssembliesGetFeaturesRequest.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 AssembliesGetFeaturesResponse call(String did,
                                                WVM wvmType,
                                                String wvm,
                                                String eid)
                                         throws OnshapeException

Calls getFeatures method, Get the definition of the feature list for an assembly

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

Calls getFeatures method, Get the definition of the feature list for an assembly

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error