Package com.onshape.api.requests

Class TranslationsCreateTranslationRequest

java.lang.Object

com.onshape.api.requests.TranslationsCreateTranslationRequest

public final class TranslationsCreateTranslationRequest
extends Object

Request object for createTranslation API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TranslationsCreateTranslationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static TranslationsCreateTranslationRequest.Builder	builder(Onshape onshape)
Boolean	getAllowFaultyParts()	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.
Boolean	getCreateComposite()	Get If the value is specified as true, each part studio contains a single composite part made up of all its topologies.
Blob	getFile()	Get File to upload
Boolean	getFlattenAssemblies()	Get If true, remove assembly structure and create only a Part Studio
String	getFormatName()	Get Name of format into which this file or element should be translated.
Boolean	getImportInBackground()	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).
Boolean	getNotifyUser()	Get Whether a user notification should be generated on completion
Boolean	getStoreInDocument()	Get controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).
String	getVersionString()	Get Version of output format to use (format-dependent)
Boolean	getYAxisIsUp()	Get If true, treat the model's Y axis as the vertical axis.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFile

public final Blob getFile()

Get File to upload

Returns:

File to upload

getFormatName

public final String getFormatName()

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.

getVersionString

public final String getVersionString()

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

Returns:

Version of output format to use (format-dependent)

getNotifyUser

public final Boolean getNotifyUser()

Get Whether a user notification should be generated on completion

Returns:

Whether a user notification should be generated on completion

getFlattenAssemblies

public final Boolean getFlattenAssemblies()

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

Returns:

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

getYAxisIsUp

public final Boolean getYAxisIsUp()

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.

getImportInBackground

public final Boolean getImportInBackground()

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.

getAllowFaultyParts

public final Boolean getAllowFaultyParts()

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.

getCreateComposite

public final Boolean getCreateComposite()

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.

getStoreInDocument

public final Boolean getStoreInDocument()

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

toString

public String toString()

Overrides:

toString in class Object

builder

public static final TranslationsCreateTranslationRequest.Builder builder(Onshape onshape)