Package com.onshape.api.requests

Class BlobElementsCreateTranslationRequest.Builder

java.lang.Object

com.onshape.api.requests.BlobElementsCreateTranslationRequest.Builder

Enclosing class:

BlobElementsCreateTranslationRequest

public static final class BlobElementsCreateTranslationRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Boolean	allowFaultyParts()	Get If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import.
BlobElementsCreateTranslationRequest.Builder	allowFaultyParts(Boolean value)	Set If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import.
BlobElementsCreateTranslationResponse	call(OnshapeDocument document)	Calls createTranslation method, Create an element translation.
BlobElementsCreateTranslationResponse	call(String did, WV wvType, String wv, String eid)	Calls createTranslation method, Create an element translation.
Boolean	createComposite()	Get If the value is specified as true, each part studio contains a single composite part made up of all its topologies.
BlobElementsCreateTranslationRequest.Builder	createComposite(Boolean value)	Set If the value is specified as true, each part studio contains a single composite part made up of all its topologies.
Boolean	flattenAssemblies()	Get If true, remove assembly structure and create only a Part Studio
BlobElementsCreateTranslationRequest.Builder	flattenAssemblies(Boolean value)	Set If true, remove assembly structure and create only a Part Studio
String	formatName()	Get Name of format into which this file or element should be translated.
BlobElementsCreateTranslationRequest.Builder	formatName(String value)	Set Name of format into which this file or element should be translated.
Boolean	importInBackground()	Get If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true).
BlobElementsCreateTranslationRequest.Builder	importInBackground(Boolean value)	Set If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true).
String	linkDocumentWorkspaceId()	Get If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.
BlobElementsCreateTranslationRequest.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	notifyUser()	Get Whether a user notification should be generated on completion
BlobElementsCreateTranslationRequest.Builder	notifyUser(Boolean value)	Set Whether a user notification should be generated on completion
Boolean	storeInDocument()	Get controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).
BlobElementsCreateTranslationRequest.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).
String	versionString()	Get Version of output format to use (format-dependent)
BlobElementsCreateTranslationRequest.Builder	versionString(String value)	Set Version of output format to use (format-dependent)
Boolean	yAxisIsUp()	Get If true, treat the model's Y axis as the vertical axis.
BlobElementsCreateTranslationRequest.Builder	yAxisIsUp(Boolean value)	Set If true, treat the model's Y axis as the vertical axis.

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 file or element should be translated.

Returns:

Name of format into which this file or element should be translated.

formatName

public final BlobElementsCreateTranslationRequest.Builder formatName(String value)

Set Name of format into which this file or element should be translated.

Parameters:

value - Name of format into which this file or element should be translated.

Returns:

the Builder object.

versionString

public final String versionString()

Get Version of output format to use (format-dependent)

Returns:

Version of output format to use (format-dependent)

versionString

public final BlobElementsCreateTranslationRequest.Builder versionString(String value)

Set Version of output format to use (format-dependent)

Parameters:

value - Version of output format to use (format-dependent)

Returns:

the Builder object.

notifyUser

public final Boolean notifyUser()

Get Whether a user notification should be generated on completion

Returns:

Whether a user notification should be generated on completion

notifyUser

public final BlobElementsCreateTranslationRequest.Builder notifyUser(Boolean value)

Set Whether a user notification should be generated on completion

Parameters:

value - Whether a user notification should be generated on completion

Returns:

the Builder object.

flattenAssemblies

public final Boolean flattenAssemblies()

Get If true, remove assembly structure and create only a Part Studio

Returns:

If true, remove assembly structure and create only a Part Studio

flattenAssemblies

public final BlobElementsCreateTranslationRequest.Builder flattenAssemblies(Boolean value)

Set If true, remove assembly structure and create only a Part Studio

Parameters:

value - If true, remove assembly structure and create only a Part Studio

Returns:

the Builder object.

yAxisIsUp

public final Boolean yAxisIsUp()

Get If true, treat the model's Y axis as the vertical axis. Otherwise, Z is treated as the vertical axis.

Returns:

If true, treat the model's Y axis as the vertical axis. Otherwise, Z is treated as the vertical axis.

yAxisIsUp

public final BlobElementsCreateTranslationRequest.Builder yAxisIsUp(Boolean value)

Set If true, treat the model's Y axis as the vertical axis. Otherwise, Z is treated as the vertical axis.

Parameters:

value - If true, treat the model's Y axis as the vertical axis. Otherwise, Z is treated as the vertical axis.

Returns:

the Builder object.

importInBackground

public final Boolean importInBackground()

Get If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true). Historically, this parameter was implicitly set to false, but large imports can take long enough that the request could result in a timeout. Applications are encouraged to set this parameter to true for reliable operation.

Returns:

If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true). Historically, this parameter was implicitly set to false, but large imports can take long enough that the request could result in a timeout. Applications are encouraged to set this parameter to true for reliable operation.

importInBackground

public final BlobElementsCreateTranslationRequest.Builder importInBackground(Boolean value)

Set If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true). Historically, this parameter was implicitly set to false, but large imports can take long enough that the request could result in a timeout. Applications are encouraged to set this parameter to true for reliable operation.

Parameters:

value - If storeInDocument is true and formatName is ONSHAPE and the source is a Parasolid file, this specifies the preference as to whether the import should be completed prior to the completion of the request (importInBackground=false) or whether it should be performed asynchronously (importInBackground=true). Historically, this parameter was implicitly set to false, but large imports can take long enough that the request could result in a timeout. Applications are encouraged to set this parameter to true for reliable operation.

Returns:

the Builder object.

allowFaultyParts

public final Boolean allowFaultyParts()

Get If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import. If all bodies are found to be faulty, the import fails. If the value is specified as true, we attempt to import the bodies that appear to have faults.

Returns:

If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import. If all bodies are found to be faulty, the import fails. If the value is specified as true, we attempt to import the bodies that appear to have faults.

allowFaultyParts

public final BlobElementsCreateTranslationRequest.Builder allowFaultyParts(Boolean value)

Set If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import. If all bodies are found to be faulty, the import fails. If the value is specified as true, we attempt to import the bodies that appear to have faults.

Parameters:

value - If not specified or if specified as false, bodies to be imported are examined for validity and any found to be faulty are removed from the import. If all bodies are found to be faulty, the import fails. If the value is specified as true, we attempt to import the bodies that appear to have faults.

Returns:

the Builder object.

createComposite

public final Boolean createComposite()

Get If the value is specified as true, each part studio contains a single composite part made up of all its topologies.

Returns:

If the value is specified as true, each part studio contains a single composite part made up of all its topologies.

createComposite

public final BlobElementsCreateTranslationRequest.Builder createComposite(Boolean value)

Set If the value is specified as true, each part studio contains a single composite part made up of all its topologies.

Parameters:

value - If the value is specified as true, each part studio contains a single composite part made up of all its topologies.

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 BlobElementsCreateTranslationRequest.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 BlobElementsCreateTranslationRequest.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 BlobElementsCreateTranslationResponse 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 BlobElementsCreateTranslationResponse 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