Package com.onshape.api.requests

Class MetadataGetMetadataRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataGetMetadataRequest.Builder

Enclosing class:

MetadataGetMetadataRequest

public static final class MetadataGetMetadataRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataGetMetadataResponse	call(OnshapeDocument document)	Calls getMetadata method, Get workspace / version metadata
MetadataGetMetadataResponse	call(String did, WV wvType, String wv)	Calls getMetadata method, Get workspace / version metadata
String	configuration()	Get Configuration string
MetadataGetMetadataRequest.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.
MetadataGetMetadataRequest.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.
MetadataGetMetadataRequest.Builder	detailLevel(Number value)	Set Filter out metadata properties by detail level, 1 - fewer fields, ..., 5 - all fields.
Number	e_limit()	Get Element page size, number of the items returned will not exceed this value
MetadataGetMetadataRequest.Builder	e_limit(Number value)	Set Element page size, number of the items returned will not exceed this value
Number	e_offset()	Get Element page offset
MetadataGetMetadataRequest.Builder	e_offset(Number value)	Set Element page offset
Boolean	inferMetadataOwner()	Get If the URL references a Standard Content part, specifying a value of true causes the API to use the owner of the referencing linkDocument as the metadata scope and the href of the returned part is modified to reflect this metadata scope.
MetadataGetMetadataRequest.Builder	inferMetadataOwner(Boolean value)	Set If the URL references a Standard Content part, specifying a value of true causes the API to use the owner of the referencing linkDocument as the metadata scope and the href of the returned part is modified to reflect this metadata scope.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
MetadataGetMetadataRequest.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.
MetadataGetMetadataRequest.Builder	noNull(Boolean value)	Set Filter out empty metadata properties if True.
Boolean	thumbnail()	Get Thumbnails information will be returned if true
MetadataGetMetadataRequest.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 MetadataGetMetadataRequest.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 MetadataGetMetadataRequest.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 MetadataGetMetadataRequest.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 MetadataGetMetadataRequest.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.

e_offset

public final Number e_offset()

Get Element page offset

Returns:

Element page offset

e_offset

public final MetadataGetMetadataRequest.Builder e_offset(Number value)

Set Element page offset

Parameters:

value - Element page offset

Returns:

the Builder object.

e_limit

public final Number e_limit()

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

Returns:

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

e_limit

public final MetadataGetMetadataRequest.Builder e_limit(Number value)

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

Parameters:

value - Element 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 MetadataGetMetadataRequest.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 MetadataGetMetadataRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

inferMetadataOwner

public final Boolean inferMetadataOwner()

Get If the URL references a Standard Content part, specifying a value of true causes the API to use the owner of the referencing linkDocument as the metadata scope and the href of the returned part is modified to reflect this metadata scope. If not explictly set or if set to false, the part metadata returned is the metadata defined internal to the Standard Content document.

Returns:

If the URL references a Standard Content part, specifying a value of true causes the API to use the owner of the referencing linkDocument as the metadata scope and the href of the returned part is modified to reflect this metadata scope. If not explictly set or if set to false, the part metadata returned is the metadata defined internal to the Standard Content document.

inferMetadataOwner

public final MetadataGetMetadataRequest.Builder inferMetadataOwner(Boolean value)

Set If the URL references a Standard Content part, specifying a value of true causes the API to use the owner of the referencing linkDocument as the metadata scope and the href of the returned part is modified to reflect this metadata scope. If not explictly set or if set to false, the part metadata returned is the metadata defined internal to the Standard Content document.

Parameters:

value - If the URL references a Standard Content part, specifying a value of true causes the API to use the owner of the referencing linkDocument as the metadata scope and the href of the returned part is modified to reflect this metadata scope. If not explictly set or if set to false, the part metadata returned is the metadata defined internal to the Standard Content document.

Returns:

the Builder object.

call

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

Calls getMetadata method, Get workspace / version metadata

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 MetadataGetMetadataResponse call(OnshapeDocument document)
                                       throws OnshapeException

Calls getMetadata method, Get workspace / version metadata

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error