Package com.onshape.api.requests

Class AssembliesCreateTranslationRequest.Builder

java.lang.Object

com.onshape.api.requests.AssembliesCreateTranslationRequest.Builder

Enclosing class:

AssembliesCreateTranslationRequest

public static final class AssembliesCreateTranslationRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AssembliesCreateTranslationResponse	call(OnshapeDocument document)	Calls createTranslation method, Create an element translation.
AssembliesCreateTranslationResponse	call(String did, WV wvType, String wv, String eid)	Calls createTranslation method, Create an element translation.
String	formatName()	Get Name of format into which this element should be translated.
AssembliesCreateTranslationRequest.Builder	formatName(String value)	Set Name of format into which this element should be translated.
Boolean	includeExportIds()	Get Whether to include topology id strings in parasolid output format.
AssembliesCreateTranslationRequest.Builder	includeExportIds(Boolean value)	Set Whether to include topology id strings in parasolid output format.
String	linkDocumentWorkspaceId()	Get If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.
AssembliesCreateTranslationRequest.Builder	linkDocumentWorkspaceId(String value)	Set If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.
Boolean	storeInDocument()	Get controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).
AssembliesCreateTranslationRequest.Builder	storeInDocument(Boolean value)	Set controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).

Methods inherited from class java.lang.Object

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

Method Detail

formatName

public final String formatName()

Get Name of format into which this element should be translated. ONSHAPE indicates that the model file should be translated into a Part Studio or Assembly.

Returns:

Name of format into which this element should be translated. ONSHAPE indicates that the model file should be translated into a Part Studio or Assembly.

formatName

public final AssembliesCreateTranslationRequest.Builder formatName(String value)

Set Name of format into which this element should be translated. ONSHAPE indicates that the model file should be translated into a Part Studio or Assembly.

Parameters:

value - Name of format into which this element should be translated. ONSHAPE indicates that the model file should be translated into a Part Studio or Assembly.

Returns:

the Builder object.

includeExportIds

public final Boolean includeExportIds()

Get Whether to include topology id strings in parasolid output format.

Returns:

Whether to include topology id strings in parasolid output format.

includeExportIds

public final AssembliesCreateTranslationRequest.Builder includeExportIds(Boolean value)

Set Whether to include topology id strings in parasolid output format.

Parameters:

value - Whether to include topology id strings in parasolid output format.

Returns:

the Builder object.

storeInDocument

public final Boolean storeInDocument()

Get controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).

Returns:

controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).

storeInDocument

public final AssembliesCreateTranslationRequest.Builder storeInDocument(Boolean value)

Set controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).

Parameters:

value - controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).

Returns:

the Builder object.

linkDocumentWorkspaceId

public final String linkDocumentWorkspaceId()

Get If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.

Returns:

If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.

linkDocumentWorkspaceId

public final AssembliesCreateTranslationRequest.Builder linkDocumentWorkspaceId(String value)

Set If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.

Parameters:

value - If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.

Returns:

the Builder object.

call

public final AssembliesCreateTranslationResponse call(String did,
                                                      WV wvType,
                                                      String wv,
                                                      String eid)
                                               throws OnshapeException

Calls createTranslation method, Create an element translation. The translation may be incomplete at the time that the call completes. If the requestState is ACTIVE, the translation can be polled until the state becomes either DONE or FAILED. Alternatively, a webhook callback can be registered for notification of translation completion. (Requires Write scope if storeInDocument is true)

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

Calls createTranslation method, Create an element translation. The translation may be incomplete at the time that the call completes. If the requestState is ACTIVE, the translation can be polled until the state becomes either DONE or FAILED. Alternatively, a webhook callback can be registered for notification of translation completion. (Requires Write scope if storeInDocument is true)

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error