Package com.onshape.api.requests

Class ElementsUpdateReferencesRequestReferenceUpdates

java.lang.Object

com.onshape.api.requests.ElementsUpdateReferencesRequestReferenceUpdates

public final class ElementsUpdateReferencesRequestReferenceUpdates
extends Object

Object used in calls to updateReferences API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElementsUpdateReferencesRequestReferenceUpdates.Builder

Field Summary

Fields

Modifier and Type	Field	Description
ElementsUpdateReferencesRequestReferenceUpdatesFromReference	fromReference	All instances or features in the element that match this reference will be updated.
String[]	idsToUpdate	The ids of items in the element that should be updated.
ElementsUpdateReferencesRequestReferenceUpdatesToReference	toReference	Identifies the destination reference for the items.

Method Summary

Modifier and Type	Method	Description
static ElementsUpdateReferencesRequestReferenceUpdates.Builder	builder()
ElementsUpdateReferencesRequestReferenceUpdatesFromReference	getFromReference()	Get All instances or features in the element that match this reference will be updated.
String[]	getIdsToUpdate()	Get The ids of items in the element that should be updated.
ElementsUpdateReferencesRequestReferenceUpdatesToReference	getToReference()	Get Identifies the destination reference for the items.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

idsToUpdate

public String[] idsToUpdate

The ids of items in the element that should be updated. For an assembly element these are the ids of the instances. For a part studio element these are the nodeIds of the features. Should not be specified with fromReference.

fromReference

public ElementsUpdateReferencesRequestReferenceUpdatesFromReference fromReference

All instances or features in the element that match this reference will be updated. Should not be specified with idsToUpdate.

toReference

public ElementsUpdateReferencesRequestReferenceUpdatesToReference toReference

Identifies the destination reference for the items.

Method Detail

getIdsToUpdate

public final String[] getIdsToUpdate()

Get The ids of items in the element that should be updated. For an assembly element these are the ids of the instances. For a part studio element these are the nodeIds of the features. Should not be specified with fromReference.

Returns:

The ids of items in the element that should be updated. For an assembly element these are the ids of the instances. For a part studio element these are the nodeIds of the features. Should not be specified with fromReference.

getFromReference

public final ElementsUpdateReferencesRequestReferenceUpdatesFromReference getFromReference()

Get All instances or features in the element that match this reference will be updated. Should not be specified with idsToUpdate.

Returns:

All instances or features in the element that match this reference will be updated. Should not be specified with idsToUpdate.

getToReference

public final ElementsUpdateReferencesRequestReferenceUpdatesToReference getToReference()

Get Identifies the destination reference for the items.

Returns:

Identifies the destination reference for the items.

builder

public static final ElementsUpdateReferencesRequestReferenceUpdates.Builder builder()

toString

public String toString()

Overrides:

toString in class Object