Package com.onshape.api.requests

Class PartStudiosUpdateFeaturesRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosUpdateFeaturesRequest.Builder

Enclosing class:

PartStudiosUpdateFeaturesRequest

public static final class PartStudiosUpdateFeaturesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosUpdateFeaturesResponse	call(OnshapeDocument document)	Calls updateFeatures method, Update parameters of existing features in the feature list for a part studio.
PartStudiosUpdateFeaturesResponse	call(String did, String wid, String eid)	Calls updateFeatures method, Update parameters of existing features in the feature list for a part studio.
Map[]	features()	Get A list of features containing updates to apply
PartStudiosUpdateFeaturesRequest.Builder	features(Map[] value)	Set A list of features containing updates to apply
Boolean	rejectMicroversionSkew()	Get If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.
PartStudiosUpdateFeaturesRequest.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
PartStudiosUpdateFeaturesRequest.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
PartStudiosUpdateFeaturesRequest.Builder	sourceMicroversion(String value)	Set The document microversion from which the features were extracted
Boolean	updateSuppressionAttributes()	Get If true, suppression attributes of the feature (suppress, suppressionState) will be updated
PartStudiosUpdateFeaturesRequest.Builder	updateSuppressionAttributes(Boolean value)	Set If true, suppression attributes of the feature (suppress, suppressionState) will be updated

Methods inherited from class java.lang.Object

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

Method Detail

updateSuppressionAttributes

public final Boolean updateSuppressionAttributes()

Get If true, suppression attributes of the feature (suppress, suppressionState) will be updated

Returns:

If true, suppression attributes of the feature (suppress, suppressionState) will be updated

updateSuppressionAttributes

public final PartStudiosUpdateFeaturesRequest.Builder updateSuppressionAttributes(Boolean value)

Set If true, suppression attributes of the feature (suppress, suppressionState) will be updated

Parameters:

value - If true, suppression attributes of the feature (suppress, suppressionState) will be updated

Returns:

the Builder object.

features

public final Map[] features()

Get A list of features containing updates to apply

Returns:

A list of features containing updates to apply

features

public final PartStudiosUpdateFeaturesRequest.Builder features(Map[] value)

Set A list of features containing updates to apply

Parameters:

value - A list of features containing updates to apply

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 PartStudiosUpdateFeaturesRequest.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 PartStudiosUpdateFeaturesRequest.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 PartStudiosUpdateFeaturesRequest.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 PartStudiosUpdateFeaturesResponse call(String did,
                                                    String wid,
                                                    String eid)
                                             throws OnshapeException

Calls updateFeatures method, Update parameters of existing features in the feature list for a part studio. Multiple features may be updated simultaneously with a single call, allowing for faster regeneration. Only the parameters that are present in the passed features are updated. Existing parameters that are not included in the passed feature are left untouched. In addition, if the field updateSuppressionAttributes is set to true, the suppress and suppressionState values for the updated features are set from the passed feature objects. 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 PartStudiosUpdateFeaturesResponse call(OnshapeDocument document)
                                             throws OnshapeException

Calls updateFeatures method, Update parameters of existing features in the feature list for a part studio. Multiple features may be updated simultaneously with a single call, allowing for faster regeneration. Only the parameters that are present in the passed features are updated. Existing parameters that are not included in the passed feature are left untouched. In addition, if the field updateSuppressionAttributes is set to true, the suppress and suppressionState values for the updated features are set from the passed feature objects. 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