Package com.onshape.api.requests

Class MetadataGetElementsMetadataRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataGetElementsMetadataRequest.Builder

Enclosing class:

MetadataGetElementsMetadataRequest

public static final class MetadataGetElementsMetadataRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataGetElementsMetadataResponse	call(OnshapeDocument document)	Calls getElementsMetadata method, Get metadata of elements in a workspace / version
MetadataGetElementsMetadataResponse	call(String did, WVM wvmType, String wvm)	Calls getElementsMetadata method, Get metadata of elements in a workspace / version
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.
MetadataGetElementsMetadataRequest.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.
MetadataGetElementsMetadataRequest.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.
MetadataGetElementsMetadataRequest.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.
MetadataGetElementsMetadataRequest.Builder	noNull(Boolean value)	Set Filter out empty metadata properties if True.
Number	p_limit()	Get Part page size, number of the items returned will not exceed this value
MetadataGetElementsMetadataRequest.Builder	p_limit(Number value)	Set Part page size, number of the items returned will not exceed this value
Number	p_offset()	Get Part page offset
MetadataGetElementsMetadataRequest.Builder	p_offset(Number value)	Set Part page offset
Boolean	thumbnail()	Get Thumbnails information will be returned if true
MetadataGetElementsMetadataRequest.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 MetadataGetElementsMetadataRequest.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 MetadataGetElementsMetadataRequest.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 MetadataGetElementsMetadataRequest.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 MetadataGetElementsMetadataRequest.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.

p_offset

public final Number p_offset()

Get Part page offset

Returns:

Part page offset

p_offset

public final MetadataGetElementsMetadataRequest.Builder p_offset(Number value)

Set Part page offset

Parameters:

value - Part page offset

Returns:

the Builder object.

p_limit

public final Number p_limit()

Get Part page size, number of the items returned will not exceed this value

Returns:

Part page size, number of the items returned will not exceed this value

p_limit

public final MetadataGetElementsMetadataRequest.Builder p_limit(Number value)

Set Part page size, number of the items returned will not exceed this value

Parameters:

value - Part page size, number of the items returned will not exceed this value

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 MetadataGetElementsMetadataRequest.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.

call

public final MetadataGetElementsMetadataResponse call(String did,
                                                      WVM wvmType,
                                                      String wvm)
                                               throws OnshapeException

Calls getElementsMetadata method, Get metadata of elements in a workspace / version

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final MetadataGetElementsMetadataResponse call(OnshapeDocument document)
                                               throws OnshapeException

Calls getElementsMetadata method, Get metadata of elements in a workspace / version

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error