Package com.onshape.api.requests

Class DocumentsGetElementListRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsGetElementListRequest.Builder

Enclosing class:

DocumentsGetElementListRequest

public static final class DocumentsGetElementListRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsGetElementListResponse	call(OnshapeDocument document)	Calls getElementList method, Get a list of elements in the workspace, version, or microversion of the document.
DocumentsGetElementListResponse	call(String did, WVM wvmType, String wvm)	Calls getElementList method, Get a list of elements in the workspace, version, or microversion of the document.
String	elementId()	Get Return only element with this ID
DocumentsGetElementListRequest.Builder	elementId(String value)	Set Return only element with this ID
String	elementType()	Get Return only elements of this elementType
DocumentsGetElementListRequest.Builder	elementType(String value)	Set Return only elements of this elementType
Boolean	withThumbnails()	Get If true, include element thumbnail information
DocumentsGetElementListRequest.Builder	withThumbnails(Boolean value)	Set If true, include element thumbnail information

Methods inherited from class java.lang.Object

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

Method Detail

elementType

public final String elementType()

Get Return only elements of this elementType

Returns:

Return only elements of this elementType

elementType

public final DocumentsGetElementListRequest.Builder elementType(String value)

Set Return only elements of this elementType

Parameters:

value - Return only elements of this elementType

Returns:

the Builder object.

elementId

public final String elementId()

Get Return only element with this ID

Returns:

Return only element with this ID

elementId

public final DocumentsGetElementListRequest.Builder elementId(String value)

Set Return only element with this ID

Parameters:

value - Return only element with this ID

Returns:

the Builder object.

withThumbnails

public final Boolean withThumbnails()

Get If true, include element thumbnail information

Returns:

If true, include element thumbnail information

withThumbnails

public final DocumentsGetElementListRequest.Builder withThumbnails(Boolean value)

Set If true, include element thumbnail information

Parameters:

value - If true, include element thumbnail information

Returns:

the Builder object.

call

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

Calls getElementList method, Get a list of elements in the workspace, version, or microversion of the document.

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

Calls getElementList method, Get a list of elements in the workspace, version, or microversion of the document.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error