Package com.onshape.api.requests

Class PartStudiosUpdateRollbackRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosUpdateRollbackRequest.Builder

Enclosing class:

PartStudiosUpdateRollbackRequest

public static final class PartStudiosUpdateRollbackRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosUpdateRollbackResponse	call(OnshapeDocument document)	Calls updateRollback method, Move the rollback bar in the feature list for a part studio.
PartStudiosUpdateRollbackResponse	call(String did, String wid, String eid)	Calls updateRollback method, Move the rollback bar in the feature list for a part studio.
Boolean	rejectMicroversionSkew()	Get If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.
PartStudiosUpdateRollbackRequest.Builder	rejectMicroversionSkew(Boolean value)	Set If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.
Number	rollbackIndex()	Get The index at which the rollback index should be placed.
PartStudiosUpdateRollbackRequest.Builder	rollbackIndex(Number value)	Set The index at which the rollback index should be placed.
String	serializationVersion()	Get The version of the serialization protocol for features
PartStudiosUpdateRollbackRequest.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
PartStudiosUpdateRollbackRequest.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

rollbackIndex

public final Number rollbackIndex()

Get The index at which the rollback index should be placed. Features with entry index (0-based) higher than or equal to this value are rolled back. The value -1 is treated as an alias for "end of feature list". Otherwise the value must be in the range 0 to the number of entries in the feature list

Returns:

The index at which the rollback index should be placed. Features with entry index (0-based) higher than or equal to this value are rolled back. The value -1 is treated as an alias for "end of feature list". Otherwise the value must be in the range 0 to the number of entries in the feature list

rollbackIndex

public final PartStudiosUpdateRollbackRequest.Builder rollbackIndex(Number value)

Set The index at which the rollback index should be placed. Features with entry index (0-based) higher than or equal to this value are rolled back. The value -1 is treated as an alias for "end of feature list". Otherwise the value must be in the range 0 to the number of entries in the feature list

Parameters:

value - The index at which the rollback index should be placed. Features with entry index (0-based) higher than or equal to this value are rolled back. The value -1 is treated as an alias for "end of feature list". Otherwise the value must be in the range 0 to the number of entries in the feature list

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

Calls updateRollback method, Move the rollback bar in the feature list for a part studio. 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 PartStudiosUpdateRollbackResponse call(OnshapeDocument document)
                                             throws OnshapeException

Calls updateRollback method, Move the rollback bar 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.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error