Package com.onshape.api.requests

Class ElementsUpdateConfigurationRequest.Builder

java.lang.Object

com.onshape.api.requests.ElementsUpdateConfigurationRequest.Builder

Enclosing class:

ElementsUpdateConfigurationRequest

public static final class ElementsUpdateConfigurationRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ElementsUpdateConfigurationResponse	call(OnshapeDocument document)	Calls updateConfiguration method, Update the configuration for a part studio or assembly.
ElementsUpdateConfigurationResponse	call(String did, String wid, String eid)	Calls updateConfiguration method, Update the configuration for a part studio or assembly.
Map[]	configurationParameters()	Get List of configuration parameters, which define the configurability of the Part Studio.
ElementsUpdateConfigurationRequest.Builder	configurationParameters(Map[] value)	Set List of configuration parameters, which define the configurability of the Part Studio.
Boolean	rejectMicroversionSkew()	Get If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.
ElementsUpdateConfigurationRequest.Builder	rejectMicroversionSkew(Boolean value)	Set If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.
String	serializationVersion()	Get The version of the serialization protocol for features
ElementsUpdateConfigurationRequest.Builder	serializationVersion(String value)	Set The version of the serialization protocol for features
String	sourceMicroversion()	Get The document microversion from which the features were extracted
ElementsUpdateConfigurationRequest.Builder	sourceMicroversion(String value)	Set The document microversion from which the features were extracted

Methods inherited from class java.lang.Object

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

Method Detail

configurationParameters

public final Map[] configurationParameters()

Get List of configuration parameters, which define the configurability of the Part Studio.

Returns:

List of configuration parameters, which define the configurability of the Part Studio.

configurationParameters

public final ElementsUpdateConfigurationRequest.Builder configurationParameters(Map[] value)

Set List of configuration parameters, which define the configurability of the Part Studio.

Parameters:

value - List of configuration parameters, which define the configurability of the Part Studio.

Returns:

the Builder object.

serializationVersion

public final String serializationVersion()

Get The version of the serialization protocol for features

Returns:

The version of the serialization protocol for features

serializationVersion

public final ElementsUpdateConfigurationRequest.Builder serializationVersion(String value)

Set The version of the serialization protocol for features

Parameters:

value - The version of the serialization protocol for features

Returns:

the Builder object.

sourceMicroversion

public final String sourceMicroversion()

Get The document microversion from which the features were extracted

Returns:

The document microversion from which the features were extracted

sourceMicroversion

public final ElementsUpdateConfigurationRequest.Builder sourceMicroversion(String value)

Set The document microversion from which the features were extracted

Parameters:

value - The document microversion from which the features were extracted

Returns:

the Builder object.

rejectMicroversionSkew

public final Boolean rejectMicroversionSkew()

Get If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.

Returns:

If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.

rejectMicroversionSkew

public final ElementsUpdateConfigurationRequest.Builder rejectMicroversionSkew(Boolean value)

Set If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.

Parameters:

value - If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.

Returns:

the Builder object.

call

public final ElementsUpdateConfigurationResponse call(String did,
                                                      String wid,
                                                      String eid)
                                               throws OnshapeException

Calls updateConfiguration method, Update the configuration for a part studio or assembly. See the developer portal feature list help topic for additional information

Parameters:

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final ElementsUpdateConfigurationResponse call(OnshapeDocument document)
                                               throws OnshapeException

Calls updateConfiguration method, Update the configuration for a part studio or assembly. See the developer portal feature list help topic for additional information

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error