Package com.onshape.api.requests

Class PartStudiosCreateTranslationRequest

java.lang.Object

com.onshape.api.requests.PartStudiosCreateTranslationRequest

public final class PartStudiosCreateTranslationRequest
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PartStudiosCreateTranslationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PartStudiosCreateTranslationRequest.Builder	builder(Onshape onshape)
String	getConfiguration()	Get A configuration string indicating the particular configuration that should be translated
String	getFormatName()	Get Name of format into which this element should be translated.
Boolean	getIncludeExportIds()	Get Whether to include topology id strings in parasolid output format.
String	getLinkDocumentWorkspaceId()	Get If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.
String	getPartIds()	Get A comma-separated list of part ids that should be translated.
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	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getConfiguration

public final String getConfiguration()

Get A configuration string indicating the particular configuration that should be translated

Returns:

A configuration string indicating the particular configuration that should be translated

getPartIds

public final String getPartIds()

Get A comma-separated list of part ids that should be translated. If not specified, all parts are translated.

Returns:

A comma-separated list of part ids that should be translated. If not specified, all parts are translated.

getFormatName

public final String getFormatName()

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.

getIncludeExportIds

public final Boolean getIncludeExportIds()

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

Returns:

Whether to include topology id strings in parasolid output format.

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

getLinkDocumentWorkspaceId

public final String getLinkDocumentWorkspaceId()

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.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final PartStudiosCreateTranslationRequest.Builder builder(Onshape onshape)