Package com.onshape.api.requests

Class MetadataUpdatePartMetadataRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataUpdatePartMetadataRequest.Builder

Enclosing class:

MetadataUpdatePartMetadataRequest

public static final class MetadataUpdatePartMetadataRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataUpdatePartMetadataResponse	call(OnshapeDocument document, String pid, PPI ppi)	Calls updatePartMetadata method, Update Part metadata
MetadataUpdatePartMetadataResponse	call(String did, WV wvType, String wv, String eid, String pid, PPI ppi)	Calls updatePartMetadata method, Update Part metadata
String	configuration()	Get Configuration string
MetadataUpdatePartMetadataRequest.Builder	configuration(String value)	Set Configuration string
MetadataUpdatePartMetadataRequestItems[]	items()	Get Collection of metadata object updates
MetadataUpdatePartMetadataRequest.Builder	items(MetadataUpdatePartMetadataRequestItems[] 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 MetadataUpdatePartMetadataRequestItems[] items()

Get Collection of metadata object updates

Returns:

Collection of metadata object updates

items

public final MetadataUpdatePartMetadataRequest.Builder items(MetadataUpdatePartMetadataRequestItems[] value)

Set Collection of metadata object updates

Parameters:

value - Collection of metadata object updates

Returns:

the Builder object.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final MetadataUpdatePartMetadataRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

public final MetadataUpdatePartMetadataResponse call(String did,
                                                     WV wvType,
                                                     String wv,
                                                     String eid,
                                                     String pid,
                                                     PPI ppi)
                                              throws OnshapeException

Calls updatePartMetadata method, Update Part metadata

Parameters:

did - Document ID

wvType - Type of Workspace or Version

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

eid - Element ID

pid - URL encoded Part ID (p) or Part identity (pi)

ppi - PPI.P (Part) or PPI.PI (Part identity)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final MetadataUpdatePartMetadataResponse call(OnshapeDocument document,
                                                     String pid,
                                                     PPI ppi)
                                              throws OnshapeException

Calls updatePartMetadata method, Update Part metadata

Parameters:

document - Document object from Onshape URL.

pid - URL encoded Part ID (p) or Part identity (pi)

ppi - PPI.P (Part) or PPI.PI (Part identity)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error