Package com.onshape.api.requests

Class DrawingsCreateTranslationRequest.Builder

java.lang.Object

com.onshape.api.requests.DrawingsCreateTranslationRequest.Builder

Enclosing class:

DrawingsCreateTranslationRequest

public static final class DrawingsCreateTranslationRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DrawingsCreateTranslationResponse	call(OnshapeDocument document)	Calls createTranslation method, Create an element translation.
DrawingsCreateTranslationResponse	call(String did, WV wvType, String wv, String eid)	Calls createTranslation method, Create an element translation.
String	colorMethod()	Get (PDF only) The color transformation that should be applied to the drawing on export.
DrawingsCreateTranslationRequest.Builder	colorMethod(String value)	Set (PDF only) The color transformation that should be applied to the drawing on export.
Boolean	currentSheetOnly()	Get (DWG only) Whether to only export the last active sheet or all sheets
DrawingsCreateTranslationRequest.Builder	currentSheetOnly(Boolean value)	Set (DWG only) Whether to only export the last active sheet or all sheets
String	destinationName()	Get Name of the output file or new element.
DrawingsCreateTranslationRequest.Builder	destinationName(String value)	Set Name of the output file or new element.
Boolean	flatten()	Get Whether to set z-height to zero and normals to positive
DrawingsCreateTranslationRequest.Builder	flatten(Boolean value)	Set Whether to set z-height to zero and normals to positive
String	formatName()	Get Name of format into which this element should be translated.
DrawingsCreateTranslationRequest.Builder	formatName(String value)	Set Name of format into which this element should be translated.
String	linkDocumentWorkspaceId()	Get If storeInDocument is true and linkDocumentId is specified, this specifies a workspace to be used for result storage within the linkDocument.
DrawingsCreateTranslationRequest.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
DrawingsCreateTranslationRequest.Builder	notifyUser(Boolean value)	Set Whether a user notification should be generated on completion
Boolean	selectablePdfText()	Get (PDF only) Controls if text on the drawing should be selectable on the output PDF.
DrawingsCreateTranslationRequest.Builder	selectablePdfText(Boolean value)	Set (PDF only) Controls if text on the drawing should be selectable on the output PDF.
Boolean	showOveriddenDimensions()	Get (DWG only) Whether overridden dimensions should be underlined
DrawingsCreateTranslationRequest.Builder	showOveriddenDimensions(Boolean value)	Set (DWG only) Whether overridden dimensions should be underlined
Boolean	splinesAsPolylines()	Get Whether splines should be converted to polylines on the export
DrawingsCreateTranslationRequest.Builder	splinesAsPolylines(Boolean value)	Set Whether splines should be converted to polylines on the export
Boolean	storeInDocument()	Get controls whether the translation is stored as a new element or whether the data is stored as external data (storeInDocument=false).
DrawingsCreateTranslationRequest.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).
Boolean	textAsGeometry()	Get Whether text should be exploded into polylines
DrawingsCreateTranslationRequest.Builder	textAsGeometry(Boolean value)	Set Whether text should be exploded into polylines
String	versionString()	Get (DWG only) Version of output format to use (format-dependent).
DrawingsCreateTranslationRequest.Builder	versionString(String value)	Set (DWG only) Version of output format to use (format-dependent).

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.

Returns:

Name of format into which this element should be translated.

formatName

public final DrawingsCreateTranslationRequest.Builder formatName(String value)

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

Parameters:

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

Returns:

the Builder object.

destinationName

public final String destinationName()

Get Name of the output file or new element. If the name does not include a file extension the extension will be derived from the formatName parameter

Returns:

Name of the output file or new element. If the name does not include a file extension the extension will be derived from the formatName parameter

destinationName

public final DrawingsCreateTranslationRequest.Builder destinationName(String value)

Set Name of the output file or new element. If the name does not include a file extension the extension will be derived from the formatName parameter

Parameters:

value - Name of the output file or new element. If the name does not include a file extension the extension will be derived from the formatName parameter

Returns:

the Builder object.

versionString

public final String versionString()

Get (DWG only) Version of output format to use (format-dependent). Currently supported formats are: 2013, 2010, 2007, 2004, 2000, R14, R13, R12

Returns:

(DWG only) Version of output format to use (format-dependent). Currently supported formats are: 2013, 2010, 2007, 2004, 2000, R14, R13, R12

versionString

public final DrawingsCreateTranslationRequest.Builder versionString(String value)

Set (DWG only) Version of output format to use (format-dependent). Currently supported formats are: 2013, 2010, 2007, 2004, 2000, R14, R13, R12

Parameters:

value - (DWG only) Version of output format to use (format-dependent). Currently supported formats are: 2013, 2010, 2007, 2004, 2000, R14, R13, R12

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

textAsGeometry

public final Boolean textAsGeometry()

Get Whether text should be exploded into polylines

Returns:

Whether text should be exploded into polylines

textAsGeometry

public final DrawingsCreateTranslationRequest.Builder textAsGeometry(Boolean value)

Set Whether text should be exploded into polylines

Parameters:

value - Whether text should be exploded into polylines

Returns:

the Builder object.

showOveriddenDimensions

public final Boolean showOveriddenDimensions()

Get (DWG only) Whether overridden dimensions should be underlined

Returns:

(DWG only) Whether overridden dimensions should be underlined

showOveriddenDimensions

public final DrawingsCreateTranslationRequest.Builder showOveriddenDimensions(Boolean value)

Set (DWG only) Whether overridden dimensions should be underlined

Parameters:

value - (DWG only) Whether overridden dimensions should be underlined

Returns:

the Builder object.

currentSheetOnly

public final Boolean currentSheetOnly()

Get (DWG only) Whether to only export the last active sheet or all sheets

Returns:

(DWG only) Whether to only export the last active sheet or all sheets

currentSheetOnly

public final DrawingsCreateTranslationRequest.Builder currentSheetOnly(Boolean value)

Set (DWG only) Whether to only export the last active sheet or all sheets

Parameters:

value - (DWG only) Whether to only export the last active sheet or all sheets

Returns:

the Builder object.

splinesAsPolylines

public final Boolean splinesAsPolylines()

Get Whether splines should be converted to polylines on the export

Returns:

Whether splines should be converted to polylines on the export

splinesAsPolylines

public final DrawingsCreateTranslationRequest.Builder splinesAsPolylines(Boolean value)

Set Whether splines should be converted to polylines on the export

Parameters:

value - Whether splines should be converted to polylines on the export

Returns:

the Builder object.

flatten

public final Boolean flatten()

Get Whether to set z-height to zero and normals to positive

Returns:

Whether to set z-height to zero and normals to positive

flatten

public final DrawingsCreateTranslationRequest.Builder flatten(Boolean value)

Set Whether to set z-height to zero and normals to positive

Parameters:

value - Whether to set z-height to zero and normals to positive

Returns:

the Builder object.

colorMethod

public final String colorMethod()

Get (PDF only) The color transformation that should be applied to the drawing on export. Supported options are: color, blackandwhite and grayscale

Returns:

(PDF only) The color transformation that should be applied to the drawing on export. Supported options are: color, blackandwhite and grayscale

colorMethod

public final DrawingsCreateTranslationRequest.Builder colorMethod(String value)

Set (PDF only) The color transformation that should be applied to the drawing on export. Supported options are: color, blackandwhite and grayscale

Parameters:

value - (PDF only) The color transformation that should be applied to the drawing on export. Supported options are: color, blackandwhite and grayscale

Returns:

the Builder object.

selectablePdfText

public final Boolean selectablePdfText()

Get (PDF only) Controls if text on the drawing should be selectable on the output PDF.

Returns:

(PDF only) Controls if text on the drawing should be selectable on the output PDF.

selectablePdfText

public final DrawingsCreateTranslationRequest.Builder selectablePdfText(Boolean value)

Set (PDF only) Controls if text on the drawing should be selectable on the output PDF.

Parameters:

value - (PDF only) Controls if text on the drawing should be selectable on the output PDF.

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 DrawingsCreateTranslationRequest.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 DrawingsCreateTranslationRequest.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 DrawingsCreateTranslationResponse 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 DrawingsCreateTranslationResponse 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