DocumentsGetInsertablesRequest.Builder (api-client 1.137.27923.860f36b32a5a API)

java.lang.Object
- com.onshape.api.requests.DocumentsGetInsertablesRequest.Builder

Enclosing class:: DocumentsGetInsertablesRequest

public static final class DocumentsGetInsertablesRequest.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`allowedApplicationMimeTypes()`	Get Comma separated list of application format ids to include
`DocumentsGetInsertablesRequest.Builder`	`allowedApplicationMimeTypes(String value)`	Set Comma separated list of application format ids to include
`String`	`allowedBlobMimeTypes()`	Get Comma separated list of blob mime types to include
`DocumentsGetInsertablesRequest.Builder`	`allowedBlobMimeTypes(String value)`	Set Comma separated list of blob mime types to include
`String`	`betaCapabilityIds()`	Get Beta capablities of the document requesting insertables
`DocumentsGetInsertablesRequest.Builder`	`betaCapabilityIds(String value)`	Set Beta capablities of the document requesting insertables
`DocumentsGetInsertablesResponse`	`call(OnshapeDocument document)`	Calls getInsertables method, Get a list of insertables in a version or workspace of the document, optionally for a specific element.
`DocumentsGetInsertablesResponse`	`call(String did, WV wvType, String wv)`	Calls getInsertables method, Get a list of insertables in a version or workspace of the document, optionally for a specific element.
`String`	`configuration()`	Get encoded configuration for element for which to get insertables
`DocumentsGetInsertablesRequest.Builder`	`configuration(String value)`	Set encoded configuration for element for which to get insertables
`String`	`elementId()`	Get id of element for which to get insertables
`DocumentsGetInsertablesRequest.Builder`	`elementId(String value)`	Set id of element for which to get insertables
`Boolean`	`includeApplications()`	Get Return applications
`DocumentsGetInsertablesRequest.Builder`	`includeApplications(Boolean value)`	Set Return applications
`Boolean`	`includeAssemblies()`	Get Returns assemblies
`DocumentsGetInsertablesRequest.Builder`	`includeAssemblies(Boolean value)`	Set Returns assemblies
`Boolean`	`includeBlobs()`	Get Returns blobs
`DocumentsGetInsertablesRequest.Builder`	`includeBlobs(Boolean value)`	Set Returns blobs
`Boolean`	`includeCompositeParts()`	Get Returns composite parts
`DocumentsGetInsertablesRequest.Builder`	`includeCompositeParts(Boolean value)`	Set Returns composite parts
`Boolean`	`includeFeatures()`	Get Returns features
`DocumentsGetInsertablesRequest.Builder`	`includeFeatures(Boolean value)`	Set Returns features
`Boolean`	`includeFeatureStudios()`	Get Returns feature studios
`DocumentsGetInsertablesRequest.Builder`	`includeFeatureStudios(Boolean value)`	Set Returns feature studios
`Boolean`	`includeFlattenedBodies()`	Get Returns flattened sheetmetal bodies
`DocumentsGetInsertablesRequest.Builder`	`includeFlattenedBodies(Boolean value)`	Set Returns flattened sheetmetal bodies
`Boolean`	`includeFSComputedPartProperties()`	Get Returns FeatureScript computed part property functions
`DocumentsGetInsertablesRequest.Builder`	`includeFSComputedPartProperties(Boolean value)`	Set Returns FeatureScript computed part property functions
`Boolean`	`includeFSTables()`	Get Returns FeatureScript tables
`DocumentsGetInsertablesRequest.Builder`	`includeFSTables(Boolean value)`	Set Returns FeatureScript tables
`Boolean`	`includeMeshes()`	Get Returns meshes
`DocumentsGetInsertablesRequest.Builder`	`includeMeshes(Boolean value)`	Set Returns meshes
`Boolean`	`includeParts()`	Get Returns parts
`DocumentsGetInsertablesRequest.Builder`	`includeParts(Boolean value)`	Set Returns parts
`Boolean`	`includePartStudios()`	Get Returns part studios
`DocumentsGetInsertablesRequest.Builder`	`includePartStudios(Boolean value)`	Set Returns part studios
`Boolean`	`includeReferenceFeatures()`	Get Returns reference features
`DocumentsGetInsertablesRequest.Builder`	`includeReferenceFeatures(Boolean value)`	Set Returns reference features
`Boolean`	`includeSketches()`	Get Returns sketches
`DocumentsGetInsertablesRequest.Builder`	`includeSketches(Boolean value)`	Set Returns sketches
`Boolean`	`includeSurfaces()`	Get Returns surfaces
`DocumentsGetInsertablesRequest.Builder`	`includeSurfaces(Boolean value)`	Set Returns surfaces
`Boolean`	`includeWires()`	Get Returns wires
`DocumentsGetInsertablesRequest.Builder`	`includeWires(Boolean value)`	Set Returns wires
`Number`	`maxFeatureScriptVersion()`	Get If specified and is greater than zero, insertables that are created using feature script version less than or equal to maxFeatureScriptVersion will be returned
`DocumentsGetInsertablesRequest.Builder`	`maxFeatureScriptVersion(Number value)`	Set If specified and is greater than zero, insertables that are created using feature script version less than or equal to maxFeatureScriptVersion will be returned

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - elementId
```
public final String elementId()
```
    Get id of element for which to get insertables
    
    Returns:
    
    id of element for which to get insertables
  - elementId
```
public final DocumentsGetInsertablesRequest.Builder elementId(String value)
```
    Set id of element for which to get insertables
    
    Parameters:
    
    value - id of element for which to get insertables
    
    Returns:
    
    the Builder object.
  - configuration
```
public final String configuration()
```
    Get encoded configuration for element for which to get insertables
    
    Returns:
    
    encoded configuration for element for which to get insertables
  - configuration
```
public final DocumentsGetInsertablesRequest.Builder configuration(String value)
```
    Set encoded configuration for element for which to get insertables
    
    Parameters:
    
    value - encoded configuration for element for which to get insertables
    
    Returns:
    
    the Builder object.
  - betaCapabilityIds
```
public final String betaCapabilityIds()
```
    Get Beta capablities of the document requesting insertables
    
    Returns:
    
    Beta capablities of the document requesting insertables
  - betaCapabilityIds
```
public final DocumentsGetInsertablesRequest.Builder betaCapabilityIds(String value)
```
    Set Beta capablities of the document requesting insertables
    
    Parameters:
    
    value - Beta capablities of the document requesting insertables
    
    Returns:
    
    the Builder object.
  - includeParts
```
public final Boolean includeParts()
```
    Get Returns parts
    
    Returns:
    
    Returns parts
  - includeParts
```
public final DocumentsGetInsertablesRequest.Builder includeParts(Boolean value)
```
    Set Returns parts
    
    Parameters:
    
    value - Returns parts
    
    Returns:
    
    the Builder object.
  - includeSurfaces
```
public final Boolean includeSurfaces()
```
    Get Returns surfaces
    
    Returns:
    
    Returns surfaces
  - includeSurfaces
```
public final DocumentsGetInsertablesRequest.Builder includeSurfaces(Boolean value)
```
    Set Returns surfaces
    
    Parameters:
    
    value - Returns surfaces
    
    Returns:
    
    the Builder object.
  - includeSketches
```
public final Boolean includeSketches()
```
    Get Returns sketches
    
    Returns:
    
    Returns sketches
  - includeSketches
```
public final DocumentsGetInsertablesRequest.Builder includeSketches(Boolean value)
```
    Set Returns sketches
    
    Parameters:
    
    value - Returns sketches
    
    Returns:
    
    the Builder object.
  - includeWires
```
public final Boolean includeWires()
```
    Get Returns wires
    
    Returns:
    
    Returns wires
  - includeWires
```
public final DocumentsGetInsertablesRequest.Builder includeWires(Boolean value)
```
    Set Returns wires
    
    Parameters:
    
    value - Returns wires
    
    Returns:
    
    the Builder object.
  - includeReferenceFeatures
```
public final Boolean includeReferenceFeatures()
```
    Get Returns reference features
    
    Returns:
    
    Returns reference features
  - includeReferenceFeatures
```
public final DocumentsGetInsertablesRequest.Builder includeReferenceFeatures(Boolean value)
```
    Set Returns reference features
    
    Parameters:
    
    value - Returns reference features
    
    Returns:
    
    the Builder object.
  - includePartStudios
```
public final Boolean includePartStudios()
```
    Get Returns part studios
    
    Returns:
    
    Returns part studios
  - includePartStudios
```
public final DocumentsGetInsertablesRequest.Builder includePartStudios(Boolean value)
```
    Set Returns part studios
    
    Parameters:
    
    value - Returns part studios
    
    Returns:
    
    the Builder object.
  - includeAssemblies
```
public final Boolean includeAssemblies()
```
    Get Returns assemblies
    
    Returns:
    
    Returns assemblies
  - includeAssemblies
```
public final DocumentsGetInsertablesRequest.Builder includeAssemblies(Boolean value)
```
    Set Returns assemblies
    
    Parameters:
    
    value - Returns assemblies
    
    Returns:
    
    the Builder object.
  - includeFeatureStudios
```
public final Boolean includeFeatureStudios()
```
    Get Returns feature studios
    
    Returns:
    
    Returns feature studios
  - includeFeatureStudios
```
public final DocumentsGetInsertablesRequest.Builder includeFeatureStudios(Boolean value)
```
    Set Returns feature studios
    
    Parameters:
    
    value - Returns feature studios
    
    Returns:
    
    the Builder object.
  - includeFeatures
```
public final Boolean includeFeatures()
```
    Get Returns features
    
    Returns:
    
    Returns features
  - includeFeatures
```
public final DocumentsGetInsertablesRequest.Builder includeFeatures(Boolean value)
```
    Set Returns features
    
    Parameters:
    
    value - Returns features
    
    Returns:
    
    the Builder object.
  - includeBlobs
```
public final Boolean includeBlobs()
```
    Get Returns blobs
    
    Returns:
    
    Returns blobs
  - includeBlobs
```
public final DocumentsGetInsertablesRequest.Builder includeBlobs(Boolean value)
```
    Set Returns blobs
    
    Parameters:
    
    value - Returns blobs
    
    Returns:
    
    the Builder object.
  - includeMeshes
```
public final Boolean includeMeshes()
```
    Get Returns meshes
    
    Returns:
    
    Returns meshes
  - includeMeshes
```
public final DocumentsGetInsertablesRequest.Builder includeMeshes(Boolean value)
```
    Set Returns meshes
    
    Parameters:
    
    value - Returns meshes
    
    Returns:
    
    the Builder object.
  - includeFlattenedBodies
```
public final Boolean includeFlattenedBodies()
```
    Get Returns flattened sheetmetal bodies
    
    Returns:
    
    Returns flattened sheetmetal bodies
  - includeFlattenedBodies
```
public final DocumentsGetInsertablesRequest.Builder includeFlattenedBodies(Boolean value)
```
    Set Returns flattened sheetmetal bodies
    
    Parameters:
    
    value - Returns flattened sheetmetal bodies
    
    Returns:
    
    the Builder object.
  - includeApplications
```
public final Boolean includeApplications()
```
    Get Return applications
    
    Returns:
    
    Return applications
  - includeApplications
```
public final DocumentsGetInsertablesRequest.Builder includeApplications(Boolean value)
```
    Set Return applications
    
    Parameters:
    
    value - Return applications
    
    Returns:
    
    the Builder object.
  - allowedBlobMimeTypes
```
public final String allowedBlobMimeTypes()
```
    Get Comma separated list of blob mime types to include
    
    Returns:
    
    Comma separated list of blob mime types to include
  - allowedBlobMimeTypes
```
public final DocumentsGetInsertablesRequest.Builder allowedBlobMimeTypes(String value)
```
    Set Comma separated list of blob mime types to include
    
    Parameters:
    
    value - Comma separated list of blob mime types to include
    
    Returns:
    
    the Builder object.
  - allowedApplicationMimeTypes
```
public final String allowedApplicationMimeTypes()
```
    Get Comma separated list of application format ids to include
    
    Returns:
    
    Comma separated list of application format ids to include
  - allowedApplicationMimeTypes
```
public final DocumentsGetInsertablesRequest.Builder allowedApplicationMimeTypes(String value)
```
    Set Comma separated list of application format ids to include
    
    Parameters:
    
    value - Comma separated list of application format ids to include
    
    Returns:
    
    the Builder object.
  - includeCompositeParts
```
public final Boolean includeCompositeParts()
```
    Get Returns composite parts
    
    Returns:
    
    Returns composite parts
  - includeCompositeParts
```
public final DocumentsGetInsertablesRequest.Builder includeCompositeParts(Boolean value)
```
    Set Returns composite parts
    
    Parameters:
    
    value - Returns composite parts
    
    Returns:
    
    the Builder object.
  - maxFeatureScriptVersion
```
public final Number maxFeatureScriptVersion()
```
    Get If specified and is greater than zero, insertables that are created using feature script version less than or equal to maxFeatureScriptVersion will be returned
    
    Returns:
    
    If specified and is greater than zero, insertables that are created using feature script version less than or equal to maxFeatureScriptVersion will be returned
  - maxFeatureScriptVersion
```
public final DocumentsGetInsertablesRequest.Builder maxFeatureScriptVersion(Number value)
```
    Set If specified and is greater than zero, insertables that are created using feature script version less than or equal to maxFeatureScriptVersion will be returned
    
    Parameters:
    
    value - If specified and is greater than zero, insertables that are created using feature script version less than or equal to maxFeatureScriptVersion will be returned
    
    Returns:
    
    the Builder object.
  - includeFSTables
```
public final Boolean includeFSTables()
```
    Get Returns FeatureScript tables
    
    Returns:
    
    Returns FeatureScript tables
  - includeFSTables
```
public final DocumentsGetInsertablesRequest.Builder includeFSTables(Boolean value)
```
    Set Returns FeatureScript tables
    
    Parameters:
    
    value - Returns FeatureScript tables
    
    Returns:
    
    the Builder object.
  - includeFSComputedPartProperties
```
public final Boolean includeFSComputedPartProperties()
```
    Get Returns FeatureScript computed part property functions
    
    Returns:
    
    Returns FeatureScript computed part property functions
  - includeFSComputedPartProperties
```
public final DocumentsGetInsertablesRequest.Builder includeFSComputedPartProperties(Boolean value)
```
    Set Returns FeatureScript computed part property functions
    
    Parameters:
    
    value - Returns FeatureScript computed part property functions
    
    Returns:
    
    the Builder object.
  - call
```
public final DocumentsGetInsertablesResponse call(String did,
                                                  WV wvType,
                                                  String wv)
                                           throws OnshapeException
```
    Calls getInsertables method, Get a list of insertables in a version or workspace of the document, optionally for a specific element.
    
    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 DocumentsGetInsertablesResponse call(OnshapeDocument document)
                                           throws OnshapeException
```
    Calls getInsertables method, Get a list of insertables in a version or workspace of the document, optionally for a specific element.
    
    Parameters:
    
    document - Document object from Onshape URL.
    
    Returns:
    
    Response object
    
    Throws:
    
    OnshapeException - On HTTP or serialization error

Class DocumentsGetInsertablesRequest.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

elementId

elementId

configuration

configuration

betaCapabilityIds

betaCapabilityIds

includeParts

includeParts

includeSurfaces

includeSurfaces

includeSketches

includeSketches

includeWires

includeWires

includeReferenceFeatures

includeReferenceFeatures

includePartStudios

includePartStudios

includeAssemblies

includeAssemblies

includeFeatureStudios

includeFeatureStudios

includeFeatures

includeFeatures

includeBlobs

includeBlobs

includeMeshes

includeMeshes

includeFlattenedBodies

includeFlattenedBodies

includeApplications

includeApplications

allowedBlobMimeTypes

allowedBlobMimeTypes

allowedApplicationMimeTypes

allowedApplicationMimeTypes

includeCompositeParts

includeCompositeParts

maxFeatureScriptVersion

maxFeatureScriptVersion

includeFSTables

includeFSTables

includeFSComputedPartProperties

includeFSComputedPartProperties

call

call