Package com.onshape.api.requests

Class PartStudiosUpdateFeatureRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosUpdateFeatureRequest.Builder

Enclosing class:

PartStudiosUpdateFeatureRequest

public static final class PartStudiosUpdateFeatureRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosUpdateFeatureResponse	call(OnshapeDocument document, String fid)	Calls updateFeature method, Update an existing feature in the feature list for a part studio.
PartStudiosUpdateFeatureResponse	call(String fid, String did, String wid, String eid)	Calls updateFeature method, Update an existing feature in the feature list for a part studio.
PartStudiosUpdateFeatureRequestFeature	feature()	Get The feature to add
PartStudiosUpdateFeatureRequest.Builder	feature(PartStudiosUpdateFeatureRequestFeature value)	Set The feature to add
Boolean	rejectMicroversionSkew()	Get If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.
PartStudiosUpdateFeatureRequest.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
PartStudiosUpdateFeatureRequest.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
PartStudiosUpdateFeatureRequest.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

feature

public final PartStudiosUpdateFeatureRequestFeature feature()

Get The feature to add

Returns:

The feature to add

feature

public final PartStudiosUpdateFeatureRequest.Builder feature(PartStudiosUpdateFeatureRequestFeature value)

Set The feature to add

Parameters:

value - The feature to add

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 PartStudiosUpdateFeatureRequest.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 PartStudiosUpdateFeatureRequest.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 PartStudiosUpdateFeatureRequest.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 PartStudiosUpdateFeatureResponse call(String fid,
                                                   String did,
                                                   String wid,
                                                   String eid)
                                            throws OnshapeException

Calls updateFeature method, Update an existing feature in the feature list for a part studio. See the developer portal feature list help topic for additional information

Parameters:

fid - The id of the feature being updated. This id should be URL encoded and must match the featureId found in the serialized structure

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartStudiosUpdateFeatureResponse call(OnshapeDocument document,
                                                   String fid)
                                            throws OnshapeException

Calls updateFeature method, Update an existing feature in the feature list for a part studio. See the developer portal feature list help topic for additional information

Parameters:

document - Document object from Onshape URL.

fid - The id of the feature being updated. This id should be URL encoded and must match the featureId found in the serialized structure

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error