Package com.onshape.api.requests

Class DocumentsCopyWorkspaceRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsCopyWorkspaceRequest.Builder

Enclosing class:

DocumentsCopyWorkspaceRequest

public static final class DocumentsCopyWorkspaceRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
String[]	betaCapabilityIds()	Get Onshape internal use
DocumentsCopyWorkspaceRequest.Builder	betaCapabilityIds(String[] value)	Set Onshape internal use
DocumentsCopyWorkspaceResponse	call(OnshapeDocument document)	Calls copyWorkspace method, Copy a workspace
DocumentsCopyWorkspaceResponse	call(String did, String wid)	Calls copyWorkspace method, Copy a workspace
Boolean	isPublic()	Get Whether new document is public (default: false)
DocumentsCopyWorkspaceRequest.Builder	isPublic(Boolean value)	Set Whether new document is public (default: false)
String	newName()	Get New document name
DocumentsCopyWorkspaceRequest.Builder	newName(String value)	Set New document name
String	ownerId()	Get Owner's user ID (default: current user)
DocumentsCopyWorkspaceRequest.Builder	ownerId(String value)	Set Owner's user ID (default: current user)
Number	ownerTypeIndex()	Get Owner's user type, which can be: 0: user 1: company 2: Team (default: 0)
DocumentsCopyWorkspaceRequest.Builder	ownerTypeIndex(Number value)	Set Owner's user type, which can be: 0: user 1: company 2: Team (default: 0)

Methods inherited from class java.lang.Object

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

Method Detail

newName

public final String newName()

Get New document name

Returns:

New document name

newName

public final DocumentsCopyWorkspaceRequest.Builder newName(String value)

Set New document name

Parameters:

value - New document name

Returns:

the Builder object.

ownerId

public final String ownerId()

Get Owner's user ID (default: current user)

Returns:

Owner's user ID (default: current user)

ownerId

public final DocumentsCopyWorkspaceRequest.Builder ownerId(String value)

Set Owner's user ID (default: current user)

Parameters:

value - Owner's user ID (default: current user)

Returns:

the Builder object.

ownerTypeIndex

public final Number ownerTypeIndex()

Get Owner's user type, which can be: 0: user 1: company 2: Team (default: 0)

Returns:

Owner's user type, which can be: 0: user 1: company 2: Team (default: 0)

ownerTypeIndex

public final DocumentsCopyWorkspaceRequest.Builder ownerTypeIndex(Number value)

Set Owner's user type, which can be: 0: user 1: company 2: Team (default: 0)

Parameters:

value - Owner's user type, which can be: 0: user 1: company 2: Team (default: 0)

Returns:

the Builder object.

betaCapabilityIds

public final String[] betaCapabilityIds()

Get Onshape internal use

Returns:

Onshape internal use

betaCapabilityIds

public final DocumentsCopyWorkspaceRequest.Builder betaCapabilityIds(String[] value)

Set Onshape internal use

Parameters:

value - Onshape internal use

Returns:

the Builder object.

isPublic

public final Boolean isPublic()

Get Whether new document is public (default: false)

Returns:

Whether new document is public (default: false)

isPublic

public final DocumentsCopyWorkspaceRequest.Builder isPublic(Boolean value)

Set Whether new document is public (default: false)

Parameters:

value - Whether new document is public (default: false)

Returns:

the Builder object.

call

public final DocumentsCopyWorkspaceResponse call(String did,
                                                 String wid)
                                          throws OnshapeException

Calls copyWorkspace method, Copy a workspace

Parameters:

did - Document ID

wid - Workspace ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final DocumentsCopyWorkspaceResponse call(OnshapeDocument document)
                                          throws OnshapeException

Calls copyWorkspace method, Copy a workspace

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error