Package com.onshape.api.requests

Class AssembliesGetBoundingBoxesRequest.Builder

java.lang.Object

com.onshape.api.requests.AssembliesGetBoundingBoxesRequest.Builder

Enclosing class:

AssembliesGetBoundingBoxesRequest

public static final class AssembliesGetBoundingBoxesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AssembliesGetBoundingBoxesResponse	call(OnshapeDocument document)	Calls getBoundingBoxes method, Get the bounding box of an Assembly, or an empty object if the Assembly is empty.
AssembliesGetBoundingBoxesResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getBoundingBoxes method, Get the bounding box of an Assembly, or an empty object if the Assembly is empty.
String	elementMicroversionId()	Get Element microversion ID
AssembliesGetBoundingBoxesRequest.Builder	elementMicroversionId(String value)	Set Element microversion ID
String	includeHidden()	Get Include hidden instances in bounding box computation
AssembliesGetBoundingBoxesRequest.Builder	includeHidden(String value)	Set Include hidden instances in bounding box computation
String	linkDocumentId()	Get Id of document that links to the document being accessed.
AssembliesGetBoundingBoxesRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

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

Method Detail

elementMicroversionId

public final String elementMicroversionId()

Get Element microversion ID

Returns:

Element microversion ID

elementMicroversionId

public final AssembliesGetBoundingBoxesRequest.Builder elementMicroversionId(String value)

Set Element microversion ID

Parameters:

value - Element microversion ID

Returns:

the Builder object.

includeHidden

public final String includeHidden()

Get Include hidden instances in bounding box computation

Returns:

Include hidden instances in bounding box computation

includeHidden

public final AssembliesGetBoundingBoxesRequest.Builder includeHidden(String value)

Set Include hidden instances in bounding box computation

Parameters:

value - Include hidden instances in bounding box computation

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 AssembliesGetBoundingBoxesRequest.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 AssembliesGetBoundingBoxesResponse call(String did,
                                                     WVM wvmType,
                                                     String wvm,
                                                     String eid)
                                              throws OnshapeException

Calls getBoundingBoxes method, Get the bounding box of an Assembly, or an empty object if the Assembly is empty. All coordinates are in meters.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

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

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AssembliesGetBoundingBoxesResponse call(OnshapeDocument document)
                                              throws OnshapeException

Calls getBoundingBoxes method, Get the bounding box of an Assembly, or an empty object if the Assembly is empty. All coordinates are in meters.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error