Package com.onshape.api.requests

Class PartStudiosIdTranslationsRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosIdTranslationsRequest.Builder

Enclosing class:

PartStudiosIdTranslationsRequest

public static final class PartStudiosIdTranslationsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosIdTranslationsResponse	call(OnshapeDocument document)	Calls idTranslations method, Translate a list of part, face, etc ids defined in a specific microversion of a document to a corresponding list of ids in the current microversion of a workspace of the document or other specific version/microversion.
PartStudiosIdTranslationsResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls idTranslations method, Translate a list of part, face, etc ids defined in a specific microversion of a document to a corresponding list of ids in the current microversion of a workspace of the document or other specific version/microversion.
String[]	ids()	Get Array of topology ID strings
PartStudiosIdTranslationsRequest.Builder	ids(String[] value)	Set Array of topology ID strings
String	linkDocumentId()	Get The id from which this request originated, in the case that it is different than :did and :wvm is not a workspace.
PartStudiosIdTranslationsRequest.Builder	linkDocumentId(String value)	Set The id from which this request originated, in the case that it is different than :did and :wvm is not a workspace.
String	sourceConfiguration()	Get Configuration of part studio in which ids were acquired
PartStudiosIdTranslationsRequest.Builder	sourceConfiguration(String value)	Set Configuration of part studio in which ids were acquired
String	sourceDocumentMicroversion()	Get document microversion of the source ids.
PartStudiosIdTranslationsRequest.Builder	sourceDocumentMicroversion(String value)	Set document microversion of the source ids.
String	targetConfiguration()	Get Configuration of part studio into which ids are to be translated
PartStudiosIdTranslationsRequest.Builder	targetConfiguration(String value)	Set Configuration of part studio into which ids are to be translated

Methods inherited from class java.lang.Object

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

Method Detail

sourceDocumentMicroversion

public final String sourceDocumentMicroversion()

Get document microversion of the source ids.

Returns:

document microversion of the source ids.

sourceDocumentMicroversion

public final PartStudiosIdTranslationsRequest.Builder sourceDocumentMicroversion(String value)

Set document microversion of the source ids.

Parameters:

value - document microversion of the source ids.

Returns:

the Builder object.

sourceConfiguration

public final String sourceConfiguration()

Get Configuration of part studio in which ids were acquired

Returns:

Configuration of part studio in which ids were acquired

sourceConfiguration

public final PartStudiosIdTranslationsRequest.Builder sourceConfiguration(String value)

Set Configuration of part studio in which ids were acquired

Parameters:

value - Configuration of part studio in which ids were acquired

Returns:

the Builder object.

targetConfiguration

public final String targetConfiguration()

Get Configuration of part studio into which ids are to be translated

Returns:

Configuration of part studio into which ids are to be translated

targetConfiguration

public final PartStudiosIdTranslationsRequest.Builder targetConfiguration(String value)

Set Configuration of part studio into which ids are to be translated

Parameters:

value - Configuration of part studio into which ids are to be translated

Returns:

the Builder object.

ids

public final String[] ids()

Get Array of topology ID strings

Returns:

Array of topology ID strings

ids

public final PartStudiosIdTranslationsRequest.Builder ids(String[] value)

Set Array of topology ID strings

Parameters:

value - Array of topology ID strings

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get The id from which this request originated, in the case that it is different than :did and :wvm is not a workspace.

Returns:

The id from which this request originated, in the case that it is different than :did and :wvm is not a workspace.

linkDocumentId

public final PartStudiosIdTranslationsRequest.Builder linkDocumentId(String value)

Set The id from which this request originated, in the case that it is different than :did and :wvm is not a workspace.

Parameters:

value - The id from which this request originated, in the case that it is different than :did and :wvm is not a workspace.

Returns:

the Builder object.

call

public final PartStudiosIdTranslationsResponse call(String did,
                                                    WVM wvmType,
                                                    String wvm,
                                                    String eid)
                                             throws OnshapeException

Calls idTranslations method, Translate a list of part, face, etc ids defined in a specific microversion of a document to a corresponding list of ids in the current microversion of a workspace of the document or other specific version/microversion. This will also allow converting between configurations, although a particular ID might not have an equivalent in another configuration.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartStudiosIdTranslationsResponse call(OnshapeDocument document)
                                             throws OnshapeException

Calls idTranslations method, Translate a list of part, face, etc ids defined in a specific microversion of a document to a corresponding list of ids in the current microversion of a workspace of the document or other specific version/microversion. This will also allow converting between configurations, although a particular ID might not have an equivalent in another configuration.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error