Package com.onshape.api.requests

Class TranslationsCreateTranslationRequest.Builder

java.lang.Object

com.onshape.api.requests.TranslationsCreateTranslationRequest.Builder

Enclosing class:

TranslationsCreateTranslationRequest

public static final class TranslationsCreateTranslationRequest.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.
TranslationsCreateTranslationRequest.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.
TranslationsCreateTranslationResponse	call(OnshapeDocument document)	Calls createTranslation method, Create a translation of the input data.
TranslationsCreateTranslationResponse	call(String did, String wid)	Calls createTranslation method, Create a translation of the input data.
Boolean	createComposite()	Get If the value is specified as true, each part studio contains a single composite part made up of all its topologies.
TranslationsCreateTranslationRequest.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.
Blob	file()	Get File to upload
TranslationsCreateTranslationRequest.Builder	file(Blob value)	Set File to upload
Boolean	flattenAssemblies()	Get If true, remove assembly structure and create only a Part Studio
TranslationsCreateTranslationRequest.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.
TranslationsCreateTranslationRequest.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).
TranslationsCreateTranslationRequest.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).
Boolean	notifyUser()	Get Whether a user notification should be generated on completion
TranslationsCreateTranslationRequest.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).
TranslationsCreateTranslationRequest.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)
TranslationsCreateTranslationRequest.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.
TranslationsCreateTranslationRequest.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

file

public final Blob file()

Get File to upload

Returns:

File to upload

file

public final TranslationsCreateTranslationRequest.Builder file(Blob value)

Set File to upload

Parameters:

value - File to upload

Returns:

the Builder object.

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

call

public final TranslationsCreateTranslationResponse call(String did,
                                                        String wid)
                                                 throws OnshapeException

Calls createTranslation method, Create a translation of the input data. 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.

Parameters:

did - Document ID

wid - Workspace ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final TranslationsCreateTranslationResponse call(OnshapeDocument document)
                                                 throws OnshapeException

Calls createTranslation method, Create a translation of the input data. 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.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error