Package com.onshape.api.requests

Class AppElementsUpdateReferenceRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsUpdateReferenceRequest.Builder

Enclosing class:

AppElementsUpdateReferenceRequest

public static final class AppElementsUpdateReferenceRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsUpdateReferenceResponse	call(OnshapeDocument document, String rid)	Calls updateReference method, Update an app element reference
AppElementsUpdateReferenceResponse	call(String rid, String did, String wid, String eid)	Calls updateReference method, Update an app element reference
String	idTag()	Get An optional deterministic id within the target element that should be tracked
AppElementsUpdateReferenceRequest.Builder	idTag(String value)	Set An optional deterministic id within the target element that should be tracked
String	idTagMicroversionId()	Get If idTag is specified, the document microversion associated with the idTag
AppElementsUpdateReferenceRequest.Builder	idTagMicroversionId(String value)	Set If idTag is specified, the document microversion associated with the idTag
String	parentChangeId()	Get Id of the prior change to the application element
AppElementsUpdateReferenceRequest.Builder	parentChangeId(String value)	Set Id of the prior change to the application element
String	targetConfiguration()	Get If not blank, specifies a new configuration of the element
AppElementsUpdateReferenceRequest.Builder	targetConfiguration(String value)	Set If not blank, specifies a new configuration of the element
String	targetElementId()	Get The element Id of the element that is or contains the target of the reference
AppElementsUpdateReferenceRequest.Builder	targetElementId(String value)	Set The element Id of the element that is or contains the target of the reference
String	targetMicroversionId()	Get An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
AppElementsUpdateReferenceRequest.Builder	targetMicroversionId(String value)	Set An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
String	targetVersionId()	Get The Id of the version the document that contains the target of the reference
AppElementsUpdateReferenceRequest.Builder	targetVersionId(String value)	Set The Id of the version the document that contains the target of the reference
String	transactionId()	Get Id of the transaction in which the reference update should occur
AppElementsUpdateReferenceRequest.Builder	transactionId(String value)	Set Id of the transaction in which the reference update should occur

Methods inherited from class java.lang.Object

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

Method Detail

transactionId

public final String transactionId()

Get Id of the transaction in which the reference update should occur

Returns:

Id of the transaction in which the reference update should occur

transactionId

public final AppElementsUpdateReferenceRequest.Builder transactionId(String value)

Set Id of the transaction in which the reference update should occur

Parameters:

value - Id of the transaction in which the reference update should occur

Returns:

the Builder object.

parentChangeId

public final String parentChangeId()

Get Id of the prior change to the application element

Returns:

Id of the prior change to the application element

parentChangeId

public final AppElementsUpdateReferenceRequest.Builder parentChangeId(String value)

Set Id of the prior change to the application element

Parameters:

value - Id of the prior change to the application element

Returns:

the Builder object.

targetElementId

public final String targetElementId()

Get The element Id of the element that is or contains the target of the reference

Returns:

The element Id of the element that is or contains the target of the reference

targetElementId

public final AppElementsUpdateReferenceRequest.Builder targetElementId(String value)

Set The element Id of the element that is or contains the target of the reference

Parameters:

value - The element Id of the element that is or contains the target of the reference

Returns:

the Builder object.

targetVersionId

public final String targetVersionId()

Get The Id of the version the document that contains the target of the reference

Returns:

The Id of the version the document that contains the target of the reference

targetVersionId

public final AppElementsUpdateReferenceRequest.Builder targetVersionId(String value)

Set The Id of the version the document that contains the target of the reference

Parameters:

value - The Id of the version the document that contains the target of the reference

Returns:

the Builder object.

targetMicroversionId

public final String targetMicroversionId()

Get An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference

Returns:

An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference

targetMicroversionId

public final AppElementsUpdateReferenceRequest.Builder targetMicroversionId(String value)

Set An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference

Parameters:

value - An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference

Returns:

the Builder object.

idTag

public final String idTag()

Get An optional deterministic id within the target element that should be tracked

Returns:

An optional deterministic id within the target element that should be tracked

idTag

public final AppElementsUpdateReferenceRequest.Builder idTag(String value)

Set An optional deterministic id within the target element that should be tracked

Parameters:

value - An optional deterministic id within the target element that should be tracked

Returns:

the Builder object.

idTagMicroversionId

public final String idTagMicroversionId()

Get If idTag is specified, the document microversion associated with the idTag

Returns:

If idTag is specified, the document microversion associated with the idTag

idTagMicroversionId

public final AppElementsUpdateReferenceRequest.Builder idTagMicroversionId(String value)

Set If idTag is specified, the document microversion associated with the idTag

Parameters:

value - If idTag is specified, the document microversion associated with the idTag

Returns:

the Builder object.

targetConfiguration

public final String targetConfiguration()

Get If not blank, specifies a new configuration of the element

Returns:

If not blank, specifies a new configuration of the element

targetConfiguration

public final AppElementsUpdateReferenceRequest.Builder targetConfiguration(String value)

Set If not blank, specifies a new configuration of the element

Parameters:

value - If not blank, specifies a new configuration of the element

Returns:

the Builder object.

call

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

Calls updateReference method, Update an app element reference

Parameters:

rid - The id of a reference to update

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AppElementsUpdateReferenceResponse call(OnshapeDocument document,
                                                     String rid)
                                              throws OnshapeException

Calls updateReference method, Update an app element reference

Parameters:

document - Document object from Onshape URL.

rid - The id of a reference to update

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error