Package com.onshape.api.requests

Class AssembliesCreateInstanceRequest.Builder

java.lang.Object

com.onshape.api.requests.AssembliesCreateInstanceRequest.Builder

Enclosing class:

AssembliesCreateInstanceRequest

public static final class AssembliesCreateInstanceRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AssembliesCreateInstanceResponse	call(OnshapeDocument document)	Calls createInstance method, Create an instance of a part, part studio or assembly into an existing assembly element.
AssembliesCreateInstanceResponse	call(String did, String wid, String eid)	Calls createInstance method, Create an instance of a part, part studio or assembly into an existing assembly element.
String	configuration()	Get Configuration of the source element, valid only if the referenced element is a Part Studio.
AssembliesCreateInstanceRequest.Builder	configuration(String value)	Set Configuration of the source element, valid only if the referenced element is a Part Studio.
String	documentId()	Get The id of the content document containing the parts or assemblies to be inserted.
AssembliesCreateInstanceRequest.Builder	documentId(String value)	Set The id of the content document containing the parts or assemblies to be inserted.
String	elementId()	Get The id of the element containing the part(s), feature or assemblies to be inserted.
AssembliesCreateInstanceRequest.Builder	elementId(String value)	Set The id of the element containing the part(s), feature or assemblies to be inserted.
String	featureId()	Get If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted.
AssembliesCreateInstanceRequest.Builder	featureId(String value)	Set If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted.
String[]	includePartTypes()	Get The part types to include.
AssembliesCreateInstanceRequest.Builder	includePartTypes(String[] value)	Set The part types to include.
Boolean	isAssembly()	Get If true then the source element must be an assembly and whole assembly is inserted.
AssembliesCreateInstanceRequest.Builder	isAssembly(Boolean value)	Set If true then the source element must be an assembly and whole assembly is inserted.
Boolean	isHidden()	Get If true add the instance as hidden
AssembliesCreateInstanceRequest.Builder	isHidden(Boolean value)	Set If true add the instance as hidden
Boolean	isSuppressed()	Get If true add the instance as suppressed
AssembliesCreateInstanceRequest.Builder	isSuppressed(Boolean value)	Set If true add the instance as suppressed
Boolean	isWholePartStudio()	Get If true then the source element must be a partStudio and all parts are inserted.
AssembliesCreateInstanceRequest.Builder	isWholePartStudio(Boolean value)	Set If true then the source element must be a partStudio and all parts are inserted.
String	microversionId()	Get The document microversionId in which the elementId and partId will be resolved.
AssembliesCreateInstanceRequest.Builder	microversionId(String value)	Set The document microversionId in which the elementId and partId will be resolved.
String	partId()	Get If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted.
AssembliesCreateInstanceRequest.Builder	partId(String value)	Set If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted.
String	partNumber()	Get The part number identifying the part or assembly in the release that is to be inserted.
AssembliesCreateInstanceRequest.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.
AssembliesCreateInstanceRequest.Builder	revision(String value)	Set The revision containing the released part or assembly to be inserted.
String	versionId()	Get The document versionId from which the parts or assembly to be inserted will be taken.
AssembliesCreateInstanceRequest.Builder	versionId(String value)	Set The document versionId from which the parts or assembly to be inserted will be taken.

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 The id of the content document containing the parts or assemblies to be inserted.

Returns:

The id of the content document containing the parts or assemblies to be inserted.

documentId

public final AssembliesCreateInstanceRequest.Builder documentId(String value)

Set The id of the content document containing the parts or assemblies to be inserted.

Parameters:

value - The id of the content document containing the parts or assemblies to be inserted.

Returns:

the Builder object.

elementId

public final String elementId()

Get The id of the element containing the part(s), feature or assemblies to be inserted.

Returns:

The id of the element containing the part(s), feature or assemblies to be inserted.

elementId

public final AssembliesCreateInstanceRequest.Builder elementId(String value)

Set The id of the element containing the part(s), feature or assemblies to be inserted.

Parameters:

value - The id of the element containing the part(s), feature or assemblies to be inserted.

Returns:

the Builder object.

versionId

public final String versionId()

Get The document versionId from which the parts or assembly to be inserted will be taken. If documentId references a different document than did, this must be set to a valid version.

Returns:

The document versionId from which the parts or assembly to be inserted will be taken. If documentId references a different document than did, this must be set to a valid version.

versionId

public final AssembliesCreateInstanceRequest.Builder versionId(String value)

Set The document versionId from which the parts or assembly to be inserted will be taken. If documentId references a different document than did, this must be set to a valid version.

Parameters:

value - The document versionId from which the parts or assembly to be inserted will be taken. If documentId references a different document than did, this must be set to a valid version.

Returns:

the Builder object.

microversionId

public final String microversionId()

Get The document microversionId in which the elementId and partId will be resolved. This is valid only if no versionId is specified. When a versionId is specified, the partId must be obtained from the specified version.

Returns:

The document microversionId in which the elementId and partId will be resolved. This is valid only if no versionId is specified. When a versionId is specified, the partId must be obtained from the specified version.

microversionId

public final AssembliesCreateInstanceRequest.Builder microversionId(String value)

Set The document microversionId in which the elementId and partId will be resolved. This is valid only if no versionId is specified. When a versionId is specified, the partId must be obtained from the specified version.

Parameters:

value - The document microversionId in which the elementId and partId will be resolved. This is valid only if no versionId is specified. When a versionId is specified, the partId must be obtained from the specified version.

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

isAssembly

public final Boolean isAssembly()

Get If true then the source element must be an assembly and whole assembly is inserted.

Returns:

If true then the source element must be an assembly and whole assembly is inserted.

isAssembly

public final AssembliesCreateInstanceRequest.Builder isAssembly(Boolean value)

Set If true then the source element must be an assembly and whole assembly is inserted.

Parameters:

value - If true then the source element must be an assembly and whole assembly is inserted.

Returns:

the Builder object.

isWholePartStudio

public final Boolean isWholePartStudio()

Get If true then the source element must be a partStudio and all parts are inserted.

Returns:

If true then the source element must be a partStudio and all parts are inserted.

isWholePartStudio

public final AssembliesCreateInstanceRequest.Builder isWholePartStudio(Boolean value)

Set If true then the source element must be a partStudio and all parts are inserted.

Parameters:

value - If true then the source element must be a partStudio and all parts are inserted.

Returns:

the Builder object.

partId

public final String partId()

Get If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted. Must be left blank if featureId is set.

Returns:

If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted. Must be left blank if featureId is set.

partId

public final AssembliesCreateInstanceRequest.Builder partId(String value)

Set If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted. Must be left blank if featureId is set.

Parameters:

value - If isAssembly and isWholePartStudio are false, then this is the id of the part or surface to be inserted. Must be left blank if featureId is set.

Returns:

the Builder object.

featureId

public final String featureId()

Get If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted. Currently, only sketch features are valid. Must be left blank if partId is set.

Returns:

If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted. Currently, only sketch features are valid. Must be left blank if partId is set.

featureId

public final AssembliesCreateInstanceRequest.Builder featureId(String value)

Set If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted. Currently, only sketch features are valid. Must be left blank if partId is set.

Parameters:

value - If isAssembly and isWholePartStudio are false, then this is the id of the feature to be inserted. Currently, only sketch features are valid. Must be left blank if partId is set.

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

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

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

call

public final AssembliesCreateInstanceResponse call(String did,
                                                   String wid,
                                                   String eid)
                                            throws OnshapeException

Calls createInstance method, Create an instance of a part, part studio or assembly into an existing assembly element. If instanceDefinition.isAssembly == true, isWholePartStudio and partId are ignored. If instanceDefinition.isWholePartStudio == true, partId is ignored If both are false, partId must point to a valid part.

Parameters:

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AssembliesCreateInstanceResponse call(OnshapeDocument document)
                                            throws OnshapeException

Calls createInstance method, Create an instance of a part, part studio or assembly into an existing assembly element. If instanceDefinition.isAssembly == true, isWholePartStudio and partId are ignored. If instanceDefinition.isWholePartStudio == true, partId is ignored If both are false, partId must point to a valid part.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error