Package com.onshape.api.requests

Class PartStudiosEvalFeatureScriptRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosEvalFeatureScriptRequest.Builder

Enclosing class:

PartStudiosEvalFeatureScriptRequest

public static final class PartStudiosEvalFeatureScriptRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosEvalFeatureScriptResponse	call(OnshapeDocument document)	Calls evalFeatureScript method, Evaluate featurescript in the context of a part studio.
PartStudiosEvalFeatureScriptResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls evalFeatureScript method, Evaluate featurescript in the context of a part studio.
String	configuration()	Get Configuration string
PartStudiosEvalFeatureScriptRequest.Builder	configuration(String value)	Set Configuration string
PartStudiosEvalFeatureScriptRequestQueries[]	queries()	Get Array of Feature Script identifier to geometry id list
PartStudiosEvalFeatureScriptRequest.Builder	queries(PartStudiosEvalFeatureScriptRequestQueries[] value)	Set Array of Feature Script identifier to geometry id list
Boolean	rejectMicroversionSkew()	Get If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.
PartStudiosEvalFeatureScriptRequest.Builder	rejectMicroversionSkew(Boolean value)	Set If set to true and the element has changed since sourceMicroversion, return an HTTP Conflict status.
String	script()	Get A Feature Script function to execute.
PartStudiosEvalFeatureScriptRequest.Builder	script(String value)	Set A Feature Script function to execute.
String	serializationVersion()	Get The version of the serialization protocol for features
PartStudiosEvalFeatureScriptRequest.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
PartStudiosEvalFeatureScriptRequest.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

script

public final String script()

Get A Feature Script function to execute.

Returns:

A Feature Script function to execute.

script

public final PartStudiosEvalFeatureScriptRequest.Builder script(String value)

Set A Feature Script function to execute.

Parameters:

value - A Feature Script function to execute.

Returns:

the Builder object.

queries

public final PartStudiosEvalFeatureScriptRequestQueries[] queries()

Get Array of Feature Script identifier to geometry id list

Returns:

Array of Feature Script identifier to geometry id list

queries

public final PartStudiosEvalFeatureScriptRequest.Builder queries(PartStudiosEvalFeatureScriptRequestQueries[] value)

Set Array of Feature Script identifier to geometry id list

Parameters:

value - Array of Feature Script identifier to geometry id 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 PartStudiosEvalFeatureScriptRequest.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 PartStudiosEvalFeatureScriptRequest.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 PartStudiosEvalFeatureScriptRequest.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.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final PartStudiosEvalFeatureScriptRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

public final PartStudiosEvalFeatureScriptResponse call(String did,
                                                       WVM wvmType,
                                                       String wvm,
                                                       String eid)
                                                throws OnshapeException

Calls evalFeatureScript method, Evaluate featurescript in the context of a part studio. See the developer portal feature list help topic for additional information

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartStudiosEvalFeatureScriptResponse call(OnshapeDocument document)
                                                throws OnshapeException

Calls evalFeatureScript method, Evaluate featurescript in the context of 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