Package com.onshape.api.requests

Class AssembliesGetAssemblyDefinitionRequest.Builder

java.lang.Object

com.onshape.api.requests.AssembliesGetAssemblyDefinitionRequest.Builder

Enclosing class:

AssembliesGetAssemblyDefinitionRequest

public static final class AssembliesGetAssemblyDefinitionRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AssembliesGetAssemblyDefinitionResponse	call(OnshapeDocument document)	Calls getAssemblyDefinition method, Get information about an Assembly.
AssembliesGetAssemblyDefinitionResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getAssemblyDefinition method, Get information about an Assembly.
String	configuration()	Get Configuration string
AssembliesGetAssemblyDefinitionRequest.Builder	configuration(String value)	Set Configuration string
Boolean	includeMateConnectors()	Get Whether or not to include mate connectors of assembly and parts when includeMateFeatures is also true (adds a "mateConnectors" array in each part and includes mate connectors in assembly "features" array).
AssembliesGetAssemblyDefinitionRequest.Builder	includeMateConnectors(Boolean value)	Set Whether or not to include mate connectors of assembly and parts when includeMateFeatures is also true (adds a "mateConnectors" array in each part and includes mate connectors in assembly "features" array).
Boolean	includeMateFeatures()	Get Whether or not to include mate features in response (adds a "features" array to response)
AssembliesGetAssemblyDefinitionRequest.Builder	includeMateFeatures(Boolean value)	Set Whether or not to include mate features in response (adds a "features" array to response)
Boolean	includeNonSolids()	Get Whether or not to include non-assembly occurrences/instances that are not parts, such as surfaces and sketches.
AssembliesGetAssemblyDefinitionRequest.Builder	includeNonSolids(Boolean value)	Set Whether or not to include non-assembly occurrences/instances that are not parts, such as surfaces and sketches.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
AssembliesGetAssemblyDefinitionRequest.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

includeMateFeatures

public final Boolean includeMateFeatures()

Get Whether or not to include mate features in response (adds a "features" array to response)

Returns:

Whether or not to include mate features in response (adds a "features" array to response)

includeMateFeatures

public final AssembliesGetAssemblyDefinitionRequest.Builder includeMateFeatures(Boolean value)

Set Whether or not to include mate features in response (adds a "features" array to response)

Parameters:

value - Whether or not to include mate features in response (adds a "features" array to response)

Returns:

the Builder object.

includeNonSolids

public final Boolean includeNonSolids()

Get Whether or not to include non-assembly occurrences/instances that are not parts, such as surfaces and sketches. When omitted or set to false, surfaces and sketches are omitted from the output, as though they are not part of the assembly definition.

Returns:

Whether or not to include non-assembly occurrences/instances that are not parts, such as surfaces and sketches. When omitted or set to false, surfaces and sketches are omitted from the output, as though they are not part of the assembly definition.

includeNonSolids

public final AssembliesGetAssemblyDefinitionRequest.Builder includeNonSolids(Boolean value)

Set Whether or not to include non-assembly occurrences/instances that are not parts, such as surfaces and sketches. When omitted or set to false, surfaces and sketches are omitted from the output, as though they are not part of the assembly definition.

Parameters:

value - Whether or not to include non-assembly occurrences/instances that are not parts, such as surfaces and sketches. When omitted or set to false, surfaces and sketches are omitted from the output, as though they are not part of the assembly definition.

Returns:

the Builder object.

includeMateConnectors

public final Boolean includeMateConnectors()

Get Whether or not to include mate connectors of assembly and parts when includeMateFeatures is also true (adds a "mateConnectors" array in each part and includes mate connectors in assembly "features" array).

Returns:

Whether or not to include mate connectors of assembly and parts when includeMateFeatures is also true (adds a "mateConnectors" array in each part and includes mate connectors in assembly "features" array).

includeMateConnectors

public final AssembliesGetAssemblyDefinitionRequest.Builder includeMateConnectors(Boolean value)

Set Whether or not to include mate connectors of assembly and parts when includeMateFeatures is also true (adds a "mateConnectors" array in each part and includes mate connectors in assembly "features" array).

Parameters:

value - Whether or not to include mate connectors of assembly and parts when includeMateFeatures is also true (adds a "mateConnectors" array in each part and includes mate connectors in assembly "features" array).

Returns:

the Builder object.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final AssembliesGetAssemblyDefinitionRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

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

Calls getAssemblyDefinition method, Get information about an Assembly. All coordinates and translation matrix components 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 AssembliesGetAssemblyDefinitionResponse call(OnshapeDocument document)
                                                   throws OnshapeException

Calls getAssemblyDefinition method, Get information about an Assembly. All coordinates and translation matrix components are in meters.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error