Package com.onshape.api.requests

Class MetadataGetPartMetadataRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataGetPartMetadataRequest.Builder

Enclosing class:

MetadataGetPartMetadataRequest

public static final class MetadataGetPartMetadataRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataGetPartMetadataResponse	call(OnshapeDocument document, String pid, PPI ppi)	Calls getPartMetadata method, Get metadata of a part in an element in a workspace / version / microversion
MetadataGetPartMetadataResponse	call(String did, WVM wvmType, String wvm, String eid, String pid, PPI ppi)	Calls getPartMetadata method, Get metadata of a part in an element in a workspace / version / microversion
String	configuration()	Get Configuration string
MetadataGetPartMetadataRequest.Builder	configuration(String value)	Set Configuration string
Number	depth()	Get Number of levels of hierarchy to populate in metadata REST API response, 1 - simple fields of top level object, 2 - collection and object fields in the top level object, etc.
MetadataGetPartMetadataRequest.Builder	depth(Number value)	Set Number of levels of hierarchy to populate in metadata REST API response, 1 - simple fields of top level object, 2 - collection and object fields in the top level object, etc.
Number	detailLevel()	Get Filter out metadata properties by detail level, 1 - fewer fields, ..., 5 - all fields.
MetadataGetPartMetadataRequest.Builder	detailLevel(Number value)	Set Filter out metadata properties by detail level, 1 - fewer fields, ..., 5 - all fields.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
MetadataGetPartMetadataRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Boolean	noNull()	Get Filter out empty metadata properties if True.
MetadataGetPartMetadataRequest.Builder	noNull(Boolean value)	Set Filter out empty metadata properties if True.
Boolean	thumbnail()	Get Thumbnails information will be returned if true
MetadataGetPartMetadataRequest.Builder	thumbnail(Boolean value)	Set Thumbnails information will be returned if true

Methods inherited from class java.lang.Object

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

Method Detail

depth

public final Number depth()

Get Number of levels of hierarchy to populate in metadata REST API response, 1 - simple fields of top level object, 2 - collection and object fields in the top level object, etc.

Returns:

Number of levels of hierarchy to populate in metadata REST API response, 1 - simple fields of top level object, 2 - collection and object fields in the top level object, etc.

depth

public final MetadataGetPartMetadataRequest.Builder depth(Number value)

Set Number of levels of hierarchy to populate in metadata REST API response, 1 - simple fields of top level object, 2 - collection and object fields in the top level object, etc.

Parameters:

value - Number of levels of hierarchy to populate in metadata REST API response, 1 - simple fields of top level object, 2 - collection and object fields in the top level object, etc.

Returns:

the Builder object.

detailLevel

public final Number detailLevel()

Get Filter out metadata properties by detail level, 1 - fewer fields, ..., 5 - all fields.

Returns:

Filter out metadata properties by detail level, 1 - fewer fields, ..., 5 - all fields.

detailLevel

public final MetadataGetPartMetadataRequest.Builder detailLevel(Number value)

Set Filter out metadata properties by detail level, 1 - fewer fields, ..., 5 - all fields.

Parameters:

value - Filter out metadata properties by detail level, 1 - fewer fields, ..., 5 - all fields.

Returns:

the Builder object.

noNull

public final Boolean noNull()

Get Filter out empty metadata properties if True.

Returns:

Filter out empty metadata properties if True.

noNull

public final MetadataGetPartMetadataRequest.Builder noNull(Boolean value)

Set Filter out empty metadata properties if True.

Parameters:

value - Filter out empty metadata properties if True.

Returns:

the Builder object.

thumbnail

public final Boolean thumbnail()

Get Thumbnails information will be returned if true

Returns:

Thumbnails information will be returned if true

thumbnail

public final MetadataGetPartMetadataRequest.Builder thumbnail(Boolean value)

Set Thumbnails information will be returned if true

Parameters:

value - Thumbnails information will be returned if true

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final MetadataGetPartMetadataRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final MetadataGetPartMetadataRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

public final MetadataGetPartMetadataResponse call(String did,
                                                  WVM wvmType,
                                                  String wvm,
                                                  String eid,
                                                  String pid,
                                                  PPI ppi)
                                           throws OnshapeException

Calls getPartMetadata method, Get metadata of a part in an element in a workspace / version / microversion

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) 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 MetadataGetPartMetadataResponse call(OnshapeDocument document,
                                                  String pid,
                                                  PPI ppi)
                                           throws OnshapeException

Calls getPartMetadata method, Get metadata of a part in an element in a workspace / version / microversion

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