Package com.onshape.api.requests

Class ElementsEncodeConfigurationRequest.Builder

java.lang.Object

com.onshape.api.requests.ElementsEncodeConfigurationRequest.Builder

Enclosing class:

ElementsEncodeConfigurationRequest

public static final class ElementsEncodeConfigurationRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ElementsEncodeConfigurationResponse	call(OnshapeDocument document)	Calls encodeConfiguration method, Encodes a configuration into a string for use in API calls to the target element
ElementsEncodeConfigurationResponse	call(String did, String eid)	Calls encodeConfiguration method, Encodes a configuration into a string for use in API calls to the target element
String	linkDocumentId()	Get Id of document that links to the document being accessed.
ElementsEncodeConfigurationRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
ElementsEncodeConfigurationRequestParameters[]	parameters()	Get Array of configuration parameters to be encoded
ElementsEncodeConfigurationRequest.Builder	parameters(ElementsEncodeConfigurationRequestParameters[] value)	Set Array of configuration parameters to be encoded
String	versionId()	Get The version of the referenced document.
ElementsEncodeConfigurationRequest.Builder	versionId(String value)	Set The version of the referenced document.

Methods inherited from class java.lang.Object

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

Method Detail

parameters

public final ElementsEncodeConfigurationRequestParameters[] parameters()

Get Array of configuration parameters to be encoded

Returns:

Array of configuration parameters to be encoded

parameters

public final ElementsEncodeConfigurationRequest.Builder parameters(ElementsEncodeConfigurationRequestParameters[] value)

Set Array of configuration parameters to be encoded

Parameters:

value - Array of configuration parameters to be encoded

Returns:

the Builder object.

versionId

public final String versionId()

Get The version of the referenced document. Meaningful only if specified together with the linkDocumentId query parameter.

Returns:

The version of the referenced document. Meaningful only if specified together with the linkDocumentId query parameter.

versionId

public final ElementsEncodeConfigurationRequest.Builder versionId(String value)

Set The version of the referenced document. Meaningful only if specified together with the linkDocumentId query parameter.

Parameters:

value - The version of the referenced document. Meaningful only if specified together with the linkDocumentId query parameter.

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final ElementsEncodeConfigurationRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

call

public final ElementsEncodeConfigurationResponse call(String did,
                                                      String eid)
                                               throws OnshapeException

Calls encodeConfiguration method, Encodes a configuration into a string for use in API calls to the target element

Parameters:

did - Document ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final ElementsEncodeConfigurationResponse call(OnshapeDocument document)
                                               throws OnshapeException

Calls encodeConfiguration method, Encodes a configuration into a string for use in API calls to the target element

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error