Package com.onshape.api.requests

Class AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder

java.lang.Object

com.onshape.api.requests.AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder

Enclosing class:

AssembliesInsertTransformedInstancesRequestTransformGroupsInstances

public static final class AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder
extends Object

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

documentId

public final String documentId()

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.

documentId

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder documentId(String value)

Set 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.

Parameters:

value - 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:

the Builder object.

elementId

public final String elementId()

Get Source element ID for the instance.

Returns:

Source element ID for the instance.

elementId

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder elementId(String value)

Set Source element ID for the instance.

Parameters:

value - Source element ID for the instance.

Returns:

the Builder object.

partId

public final String partId()

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.

partId

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder partId(String value)

Set Part ID of instance, if it's a part or surface. Must be left blank if featureId is set.

Parameters:

value - Part ID of instance, if it's a part or surface. Must be left blank if featureId is set.

Returns:

the Builder object.

featureId

public final String featureId()

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.

featureId

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder featureId(String value)

Set Feature ID of instance, if it's a feature. Currently, only sketch features are valid. Must be left blank if partId is set.

Parameters:

value - Feature ID of instance, if it's a feature. Currently, only sketch features are valid. Must be left blank if partId is set.

Returns:

the Builder object.

microversionId

public final String microversionId()

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.

microversionId

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder microversionId(String value)

Set Source document microversion ID in which to resolve elementId and partId. This must be left empty if a versionId is specified.

Parameters:

value - Source document microversion ID in which to resolve elementId and partId. This must be left empty if a versionId is specified.

Returns:

the Builder object.

versionId

public final String versionId()

Get Document version ID in which to resolve elementId and partId.

Returns:

Document version ID in which to resolve elementId and partId.

versionId

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder versionId(String value)

Set Document version ID in which to resolve elementId and partId.

Parameters:

value - Document version ID in which to resolve elementId and partId.

Returns:

the Builder object.

configuration

public final String configuration()

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.

configuration

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder configuration(String value)

Set Configuration of the source element, valid only if the referenced element is a Part Studio.

Parameters:

value - Configuration of the source element, valid only if the referenced element is a Part Studio.

Returns:

the Builder object.

isWholePartStudio

public final Boolean isWholePartStudio()

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.

isWholePartStudio

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder isWholePartStudio(Boolean value)

Set Whether the instance is the entire part studio specified by the element ID.

Parameters:

value - Whether the instance is the entire part studio specified by the element ID.

Returns:

the Builder object.

includePartTypes

public final String[] includePartTypes()

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"}.

includePartTypes

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder includePartTypes(String[] value)

Set The part types to include. used only if "isWholePartStudio" is "true". Can be: {"PARTS", "SKETCHES","SURFACES","FLATTENED_PARTS", "COMPOSITE_PARTS", "PART_STUDIOS", "WIRES", "UNKNOWN"}.

Parameters:

value - 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 Builder object.

isAssembly

public final Boolean isAssembly()

Get Whether the instance is the assembly specified by the element ID.

Returns:

Whether the instance is the assembly specified by the element ID.

isAssembly

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder isAssembly(Boolean value)

Set Whether the instance is the assembly specified by the element ID.

Parameters:

value - Whether the instance is the assembly specified by the element ID.

Returns:

the Builder object.

isSuppressed

public final Boolean isSuppressed()

Get If true add the instance as suppressed

Returns:

If true add the instance as suppressed

isSuppressed

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder isSuppressed(Boolean value)

Set If true add the instance as suppressed

Parameters:

value - If true add the instance as suppressed

Returns:

the Builder object.

isHidden

public final Boolean isHidden()

Get If true add the instance as hidden

Returns:

If true add the instance as hidden

isHidden

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder isHidden(Boolean value)

Set If true add the instance as hidden

Parameters:

value - If true add the instance as hidden

Returns:

the Builder object.

revision

public final String revision()

Get The revision containing the released part or assembly to be inserted.

Returns:

The revision containing the released part or assembly to be inserted.

revision

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder revision(String value)

Set The revision containing the released part or assembly to be inserted.

Parameters:

value - The revision containing the released part or assembly to be inserted.

Returns:

the Builder object.

partNumber

public final String partNumber()

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.

partNumber

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances.Builder partNumber(String value)

Set The part number identifying the part or assembly in the release that is to be inserted.

Parameters:

value - The part number identifying the part or assembly in the release that is to be inserted.

Returns:

the Builder object.

build

public final AssembliesInsertTransformedInstancesRequestTransformGroupsInstances build()