AssembliesInsertTransformedInstancesRequestTransformGroupsInstances (api-client 1.137.27923.860f36b32a5a API)

java.lang.Object
- com.onshape.api.requests.AssembliesInsertTransformedInstancesRequestTransformGroupsInstances

public final class AssembliesInsertTransformedInstancesRequestTransformGroupsInstances
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder

Nested Classes
Modifier and Type	Class	Description
`static class`	`AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder`

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`configuration`	Configuration of the source element, valid only if the referenced element is a Part Studio.
`String`	`documentId`	Source document ID for the instance.
`String`	`elementId`	Source element ID for the instance.
`String`	`featureId`	Feature ID of instance, if it's a feature.
`String[]`	`includePartTypes`	The part types to include.
`Boolean`	`isAssembly`	Whether the instance is the assembly specified by the element ID.
`Boolean`	`isHidden`	If true add the instance as hidden
`Boolean`	`isSuppressed`	If true add the instance as suppressed
`Boolean`	`isWholePartStudio`	Whether the instance is the entire part studio specified by the element ID.
`String`	`microversionId`	Source document microversion ID in which to resolve elementId and partId.
`String`	`partId`	Part ID of instance, if it's a part or surface.
`String`	`partNumber`	The part number identifying the part or assembly in the release that is to be inserted.
`String`	`revision`	The revision containing the released part or assembly to be inserted.
`String`	`versionId`	Document version ID in which to resolve elementId and partId.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder`	`builder()`
`String`	`getConfiguration()`	Get Configuration of the source element, valid only if the referenced element is a Part Studio.
`String`	`getDocumentId()`	Get Source document ID for the instance.
`String`	`getElementId()`	Get Source element ID for the instance.
`String`	`getFeatureId()`	Get Feature ID of instance, if it's a feature.
`String[]`	`getIncludePartTypes()`	Get The part types to include.
`Boolean`	`getIsAssembly()`	Get Whether the instance is the assembly specified by the element ID.
`Boolean`	`getIsHidden()`	Get If true add the instance as hidden
`Boolean`	`getIsSuppressed()`	Get If true add the instance as suppressed
`Boolean`	`getIsWholePartStudio()`	Get Whether the instance is the entire part studio specified by the element ID.
`String`	`getMicroversionId()`	Get Source document microversion ID in which to resolve elementId and partId.
`String`	`getPartId()`	Get Part ID of instance, if it's a part or surface.
`String`	`getPartNumber()`	Get The part number identifying the part or assembly in the release that is to be inserted.
`String`	`getRevision()`	Get The revision containing the released part or assembly to be inserted.
`String`	`getVersionId()`	Get Document version ID in which to resolve elementId and partId.
`String`	`toString()`

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

- Field Detail
  - documentId
```
public String documentId
```
    Source document ID for the instance. If this differs from the same document as in the path, you must specify a versionId for the instance in the source document.
  - elementId
```
public String elementId
```
    Source element ID for the instance.
  - partId
```
public String partId
```
    Part ID of instance, if it's a part or surface. Must be left blank if featureId is set.
  - featureId
```
public String featureId
```
    Feature ID of instance, if it's a feature. Currently, only sketch features are valid. Must be left blank if partId is set.
  - microversionId
```
public String microversionId
```
    Source document microversion ID in which to resolve elementId and partId. This must be left empty if a versionId is specified.
  - versionId
```
public String versionId
```
    Document version ID in which to resolve elementId and partId.
  - configuration
```
public String configuration
```
    Configuration of the source element, valid only if the referenced element is a Part Studio.
  - isWholePartStudio
```
public Boolean isWholePartStudio
```
    Whether the instance is the entire part studio specified by the element ID.
  - includePartTypes
```
public String[] includePartTypes
```
    The part types to include. used only if "isWholePartStudio" is "true". Can be: {"PARTS", "SKETCHES","SURFACES","FLATTENED_PARTS", "COMPOSITE_PARTS", "PART_STUDIOS", "WIRES", "UNKNOWN"}.
  - isAssembly
```
public Boolean isAssembly
```
    Whether the instance is the assembly specified by the element ID.
  - isSuppressed
```
public Boolean isSuppressed
```
    If true add the instance as suppressed
  - isHidden
```
public Boolean isHidden
```
    If true add the instance as hidden
  - revision
```
public String revision
```
    The revision containing the released part or assembly to be inserted.
  - partNumber
```
public String partNumber
```
    The part number identifying the part or assembly in the release that is to be inserted.
- Method Detail
  - getDocumentId
```
public final String getDocumentId()
```
    Get Source document ID for the instance. If this differs from the same document as in the path, you must specify a versionId for the instance in the source document.
    
    Returns:
    
    Source document ID for the instance. If this differs from the same document as in the path, you must specify a versionId for the instance in the source document.
  - getElementId
```
public final String getElementId()
```
    Get Source element ID for the instance.
    
    Returns:
    
    Source element ID for the instance.
  - getPartId
```
public final String getPartId()
```
    Get Part ID of instance, if it's a part or surface. Must be left blank if featureId is set.
    
    Returns:
    
    Part ID of instance, if it's a part or surface. Must be left blank if featureId is set.
  - getFeatureId
```
public final String getFeatureId()
```
    Get Feature ID of instance, if it's a feature. Currently, only sketch features are valid. Must be left blank if partId is set.
    
    Returns:
    
    Feature ID of instance, if it's a feature. Currently, only sketch features are valid. Must be left blank if partId is set.
  - getMicroversionId
```
public final String getMicroversionId()
```
    Get Source document microversion ID in which to resolve elementId and partId. This must be left empty if a versionId is specified.
    
    Returns:
    
    Source document microversion ID in which to resolve elementId and partId. This must be left empty if a versionId is specified.
  - getVersionId
```
public final String getVersionId()
```
    Get Document version ID in which to resolve elementId and partId.
    
    Returns:
    
    Document version ID in which to resolve elementId and partId.
  - getConfiguration
```
public final String getConfiguration()
```
    Get Configuration of the source element, valid only if the referenced element is a Part Studio.
    
    Returns:
    
    Configuration of the source element, valid only if the referenced element is a Part Studio.
  - getIsWholePartStudio
```
public final Boolean getIsWholePartStudio()
```
    Get Whether the instance is the entire part studio specified by the element ID.
    
    Returns:
    
    Whether the instance is the entire part studio specified by the element ID.
  - getIncludePartTypes
```
public final String[] getIncludePartTypes()
```
    Get The part types to include. used only if "isWholePartStudio" is "true". Can be: {"PARTS", "SKETCHES","SURFACES","FLATTENED_PARTS", "COMPOSITE_PARTS", "PART_STUDIOS", "WIRES", "UNKNOWN"}.
    
    Returns:
    
    The part types to include. used only if "isWholePartStudio" is "true". Can be: {"PARTS", "SKETCHES","SURFACES","FLATTENED_PARTS", "COMPOSITE_PARTS", "PART_STUDIOS", "WIRES", "UNKNOWN"}.
  - getIsAssembly
```
public final Boolean getIsAssembly()
```
    Get Whether the instance is the assembly specified by the element ID.
    
    Returns:
    
    Whether the instance is the assembly specified by the element ID.
  - getIsSuppressed
```
public final Boolean getIsSuppressed()
```
    Get If true add the instance as suppressed
    
    Returns:
    
    If true add the instance as suppressed
  - getIsHidden
```
public final Boolean getIsHidden()
```
    Get If true add the instance as hidden
    
    Returns:
    
    If true add the instance as hidden
  - getRevision
```
public final String getRevision()
```
    Get The revision containing the released part or assembly to be inserted.
    
    Returns:
    
    The revision containing the released part or assembly to be inserted.
  - getPartNumber
```
public final String getPartNumber()
```
    Get The part number identifying the part or assembly in the release that is to be inserted.
    
    Returns:
    
    The part number identifying the part or assembly in the release that is to be inserted.
  - builder
```
public static final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder builder()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AssembliesInsertTransformedInstancesRequestTransformGroupsInstances

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

documentId

elementId

partId

featureId

microversionId

versionId

configuration

isWholePartStudio

includePartTypes

isAssembly

isSuppressed

isHidden

revision

partNumber

Method Detail

getDocumentId

getElementId

getPartId

getFeatureId

getMicroversionId

getVersionId

getConfiguration

getIsWholePartStudio

getIncludePartTypes

getIsAssembly

getIsSuppressed

getIsHidden

getRevision

getPartNumber

builder

toString