Package com.onshape.api.requests

Class MetadataUpdateMetadataRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataUpdateMetadataRequest.Builder

Enclosing class:

MetadataUpdateMetadataRequest

public static final class MetadataUpdateMetadataRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataUpdateMetadataResponse	call(OnshapeDocument document)	Calls updateMetadata method, Update metadata.
MetadataUpdateMetadataResponse	call(String did, WV wvType, String wv)	Calls updateMetadata method, Update metadata.
MetadataUpdateMetadataRequestItems[]	items()	Get Collection of metadata object updates
MetadataUpdateMetadataRequest.Builder	items(MetadataUpdateMetadataRequestItems[] value)	Set Collection of metadata object updates

Methods inherited from class java.lang.Object

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

Method Detail

items

public final MetadataUpdateMetadataRequestItems[] items()

Get Collection of metadata object updates

Returns:

Collection of metadata object updates

items

public final MetadataUpdateMetadataRequest.Builder items(MetadataUpdateMetadataRequestItems[] value)

Set Collection of metadata object updates

Parameters:

value - Collection of metadata object updates

Returns:

the Builder object.

call

public final MetadataUpdateMetadataResponse call(String did,
                                                 WV wvType,
                                                 String wv)
                                          throws OnshapeException

Calls updateMetadata method, Update metadata. Updates of parts in configurable Par Studios require configuration information be included within the items.*.href fields for a specific part. The response format varies depending on whether there are multiple items to update.

Parameters:

did - Document ID

wvType - Type of Workspace or Version

wv - Workspace (w) or Version (v) ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final MetadataUpdateMetadataResponse call(OnshapeDocument document)
                                          throws OnshapeException

Calls updateMetadata method, Update metadata. Updates of parts in configurable Par Studios require configuration information be included within the items.*.href fields for a specific part. The response format varies depending on whether there are multiple items to update.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error