Package com.onshape.api.requests

Class DocumentsCreateWorkspaceRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsCreateWorkspaceRequest.Builder

Enclosing class:

DocumentsCreateWorkspaceRequest

public static final class DocumentsCreateWorkspaceRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsCreateWorkspaceResponse	call(OnshapeDocument document)	Calls createWorkspace method, Creates a new workspace.
DocumentsCreateWorkspaceResponse	call(String did)	Calls createWorkspace method, Creates a new workspace.
Number	clientInteractionMode()	Get Reserved for internal use
DocumentsCreateWorkspaceRequest.Builder	clientInteractionMode(Number value)	Set Reserved for internal use
String	description()	Get Workspace description
DocumentsCreateWorkspaceRequest.Builder	description(String value)	Set Workspace description
String	microversionId()	Get Microversion ID of parent document microversion
DocumentsCreateWorkspaceRequest.Builder	microversionId(String value)	Set Microversion ID of parent document microversion
String	name()	Get Workspace name (not required if readOnly=true)
DocumentsCreateWorkspaceRequest.Builder	name(String value)	Set Workspace name (not required if readOnly=true)
Boolean	readOnly()	Get Reserved for internal use
DocumentsCreateWorkspaceRequest.Builder	readOnly(Boolean value)	Set Reserved for internal use
String	versionId()	Get Version ID of parent version
DocumentsCreateWorkspaceRequest.Builder	versionId(String value)	Set Version ID of parent version
String	workspaceId()	Get Workspace ID of parent workspace
DocumentsCreateWorkspaceRequest.Builder	workspaceId(String value)	Set Workspace ID of parent workspace

Methods inherited from class java.lang.Object

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

Method Detail

versionId

public final String versionId()

Get Version ID of parent version

Returns:

Version ID of parent version

versionId

public final DocumentsCreateWorkspaceRequest.Builder versionId(String value)

Set Version ID of parent version

Parameters:

value - Version ID of parent version

Returns:

the Builder object.

microversionId

public final String microversionId()

Get Microversion ID of parent document microversion

Returns:

Microversion ID of parent document microversion

microversionId

public final DocumentsCreateWorkspaceRequest.Builder microversionId(String value)

Set Microversion ID of parent document microversion

Parameters:

value - Microversion ID of parent document microversion

Returns:

the Builder object.

workspaceId

public final String workspaceId()

Get Workspace ID of parent workspace

Returns:

Workspace ID of parent workspace

workspaceId

public final DocumentsCreateWorkspaceRequest.Builder workspaceId(String value)

Set Workspace ID of parent workspace

Parameters:

value - Workspace ID of parent workspace

Returns:

the Builder object.

name

public final String name()

Get Workspace name (not required if readOnly=true)

Returns:

Workspace name (not required if readOnly=true)

name

public final DocumentsCreateWorkspaceRequest.Builder name(String value)

Set Workspace name (not required if readOnly=true)

Parameters:

value - Workspace name (not required if readOnly=true)

Returns:

the Builder object.

description

public final String description()

Get Workspace description

Returns:

Workspace description

description

public final DocumentsCreateWorkspaceRequest.Builder description(String value)

Set Workspace description

Parameters:

value - Workspace description

Returns:

the Builder object.

readOnly

public final Boolean readOnly()

Get Reserved for internal use

Returns:

Reserved for internal use

readOnly

public final DocumentsCreateWorkspaceRequest.Builder readOnly(Boolean value)

Set Reserved for internal use

Parameters:

value - Reserved for internal use

Returns:

the Builder object.

clientInteractionMode

public final Number clientInteractionMode()

Get Reserved for internal use

Returns:

Reserved for internal use

clientInteractionMode

public final DocumentsCreateWorkspaceRequest.Builder clientInteractionMode(Number value)

Set Reserved for internal use

Parameters:

value - Reserved for internal use

Returns:

the Builder object.

call

public final DocumentsCreateWorkspaceResponse call(String did)
                                            throws OnshapeException

Calls createWorkspace method, Creates a new workspace. The starting point for the workspace can be specified using one of microversionId, workspaceId, versionId in that precedence order. A workspace also has a parent that may be specified or implied. If the starting point is taken from workspaceId or versionId, the parent version is implied to be the workspace parent or the version, respectively. If the starting point used is microversionId then the parent version is chosen based on workspaceId, versionId and default workspace, in that precedence order. If chosen based on a workspaceId, the version is the parent of the chosen workspace. If the effective version parentId is not a true parent of the starting microversion, an error is returned.

Parameters:

did - Document ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final DocumentsCreateWorkspaceResponse call(OnshapeDocument document)
                                            throws OnshapeException

Calls createWorkspace method, Creates a new workspace. The starting point for the workspace can be specified using one of microversionId, workspaceId, versionId in that precedence order. A workspace also has a parent that may be specified or implied. If the starting point is taken from workspaceId or versionId, the parent version is implied to be the workspace parent or the version, respectively. If the starting point used is microversionId then the parent version is chosen based on workspaceId, versionId and default workspace, in that precedence order. If chosen based on a workspaceId, the version is the parent of the chosen workspace. If the effective version parentId is not a true parent of the starting microversion, an error is returned.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error