Package com.onshape.api.responses

Class TranslationsGetTranslationsResponseItems

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.TranslationsGetTranslationsResponseItems

All Implemented Interfaces:

ResponseWithDocument

public final class TranslationsGetTranslationsResponseItems
extends AbstractResponseObject
implements ResponseWithDocument

Object used in calls to getTranslations API endpoint. © 2018-Present Onshape Inc.

Field Summary

Fields

Modifier and Type	Field	Description
String	documentId	The id of the document that contains the translation
String	failureReason	A string indicating the reason for the failure, if known.
String	href	The URI for accessing this translation
String	id	The id of this translation
String	requestElementId	The id of the element being translated
String	requestState	The state if of this translation request.
String[]	resultElementIds	The ids of the elements containing the translation results, if stored in the document
String[]	resultExternalDataIds	The ids of the external data containing the translation results, if not stored in the document
String	workspaceId	The id of the document workspace that contains the translation

Constructor Summary

Constructors

Constructor	Description
TranslationsGetTranslationsResponseItems()

Method Summary

Modifier and Type	Method	Description
OnshapeDocument	getDocument()	Returns an OnshapeDocument object that can be used in subsequent calls to the related document
String	getDocumentId()	Get The id of the document that contains the translation
String	getFailureReason()	Get A string indicating the reason for the failure, if known.
String	getHref()	Get The URI for accessing this translation
String	getId()	Get The id of this translation
String	getRequestElementId()	Get The id of the element being translated
String	getRequestState()	Get The state if of this translation request.
String[]	getResultElementIds()	Get The ids of the elements containing the translation results, if stored in the document
String[]	getResultExternalDataIds()	Get The ids of the external data containing the translation results, if not stored in the document
String	getWorkspaceId()	Get The id of the document workspace that contains the translation
String	toString()

Methods inherited from class com.onshape.api.types.AbstractResponseObject

getOtherProperties

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

The id of this translation

href

public String href

The URI for accessing this translation

documentId

public String documentId

The id of the document that contains the translation

workspaceId

public String workspaceId

The id of the document workspace that contains the translation

requestElementId

public String requestElementId

The id of the element being translated

requestState

public String requestState

The state if of this translation request. (ACTIVE|DONE|FAILED)

resultElementIds

public String[] resultElementIds

The ids of the elements containing the translation results, if stored in the document

resultExternalDataIds

public String[] resultExternalDataIds

The ids of the external data containing the translation results, if not stored in the document

failureReason

public String failureReason

A string indicating the reason for the failure, if known.

Constructor Detail

TranslationsGetTranslationsResponseItems

public TranslationsGetTranslationsResponseItems()

Method Detail

getId

public final String getId()

Get The id of this translation

Returns:

The id of this translation

getHref

public final String getHref()

Get The URI for accessing this translation

Returns:

The URI for accessing this translation

getDocumentId

public final String getDocumentId()

Get The id of the document that contains the translation

Returns:

The id of the document that contains the translation

getWorkspaceId

public final String getWorkspaceId()

Get The id of the document workspace that contains the translation

Returns:

The id of the document workspace that contains the translation

getRequestElementId

public final String getRequestElementId()

Get The id of the element being translated

Returns:

The id of the element being translated

getRequestState

public final String getRequestState()

Get The state if of this translation request. (ACTIVE|DONE|FAILED)

Returns:

The state if of this translation request. (ACTIVE|DONE|FAILED)

getResultElementIds

public final String[] getResultElementIds()

Get The ids of the elements containing the translation results, if stored in the document

Returns:

The ids of the elements containing the translation results, if stored in the document

getResultExternalDataIds

public final String[] getResultExternalDataIds()

Get The ids of the external data containing the translation results, if not stored in the document

Returns:

The ids of the external data containing the translation results, if not stored in the document

getFailureReason

public final String getFailureReason()

Get A string indicating the reason for the failure, if known.

Returns:

A string indicating the reason for the failure, if known.

getDocument

public final OnshapeDocument getDocument()

Returns an OnshapeDocument object that can be used in subsequent calls to the related document

Specified by:

getDocument in interface ResponseWithDocument

Returns:

The OnshapeDocument object.

toString

public String toString()

Overrides:

toString in class Object