Package com.onshape.api.responses

Class AssembliesCreateTranslationResponse

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.AssembliesCreateTranslationResponse

All Implemented Interfaces:

ResponseWithDocument

public final class AssembliesCreateTranslationResponse
extends AbstractResponseObject
implements ResponseWithDocument

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

Constructor Summary

Constructors

Constructor	Description
AssembliesCreateTranslationResponse()

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AssembliesCreateTranslationResponse>	asFuture(Onshape onshape)	Returns a CompletableFuture that will be complete when this process is no longer in an "ACTIVE" state
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 source
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 of this translation request.
String	getResultDocumentId()	Get The id of the document containing the translation results, if stored in the document, or with which the externalDataIds are associated
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	getResultWorkspaceId()	Get The id of the workspace containing the translation results, if stored in the document
String	getVersionId()	Get The id of the document version that contains the translation source
String	getWorkspaceId()	Get The id of the document workspace that contains the translation source
AssembliesCreateTranslationResponse	refresh(Onshape onshape)	Refresh this page of results
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

Constructor Detail

AssembliesCreateTranslationResponse

public AssembliesCreateTranslationResponse()

Method Detail

refresh

public final AssembliesCreateTranslationResponse refresh(Onshape onshape)
                                                  throws OnshapeException

Refresh this page of results

Parameters:

onshape - The Onshape client object.

Returns:

Updated response.

Throws:

OnshapeException - On HTTP or serialization error.

asFuture

public final CompletableFuture<AssembliesCreateTranslationResponse> asFuture(Onshape onshape)

Returns a CompletableFuture that will be complete when this process is no longer in an "ACTIVE" state

Parameters:

onshape - The Onshape client object.

Returns:

Future for this response.

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.

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 source

Returns:

The id of the document that contains the translation source

getWorkspaceId

public final String getWorkspaceId()

Get The id of the document workspace that contains the translation source

Returns:

The id of the document workspace that contains the translation source

getVersionId

public final String getVersionId()

Get The id of the document version that contains the translation source

Returns:

The id of the document version that contains the translation source

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 of this translation request. (ACTIVE|DONE|FAILED)

Returns:

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

getResultDocumentId

public final String getResultDocumentId()

Get The id of the document containing the translation results, if stored in the document, or with which the externalDataIds are associated

Returns:

The id of the document containing the translation results, if stored in the document, or with which the externalDataIds are associated

getResultWorkspaceId

public final String getResultWorkspaceId()

Get The id of the workspace containing the translation results, if stored in the document

Returns:

The id of the workspace containing the translation results, if stored in the document

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.

toString

public String toString()

Overrides:

toString in class Object