Package com.onshape.api.requests

Class DocumentsCreateDocumentRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsCreateDocumentRequest.Builder

Enclosing class:

DocumentsCreateDocumentRequest

public static final class DocumentsCreateDocumentRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
String[]	betaCapabilityIds()	Get Onshape internal use
DocumentsCreateDocumentRequest.Builder	betaCapabilityIds(String[] value)	Set Onshape internal use
DocumentsCreateDocumentResponse	call()	Calls createDocument method, Create document
DocumentsCreateDocumentRequestElements[]	elements()	Get custom elements definition to be created with document.
DocumentsCreateDocumentRequest.Builder	elements(DocumentsCreateDocumentRequestElements[] value)	Set custom elements definition to be created with document.
Boolean	isGenerateUnknownMessages()	Get Onshape internal use
DocumentsCreateDocumentRequest.Builder	isGenerateUnknownMessages(Boolean value)	Set Onshape internal use
Boolean	isPublic()	Get Whether document is public
DocumentsCreateDocumentRequest.Builder	isPublic(Boolean value)	Set Whether document is public
String	name()	Get Document name
DocumentsCreateDocumentRequest.Builder	name(String value)	Set Document name
String	ownerId()	Get Owner's user ID (default: current user)
DocumentsCreateDocumentRequest.Builder	ownerId(String value)	Set Owner's user ID (default: current user)
Number	ownerType()	Get Owner's user type, which can be 0: user, 1: company
DocumentsCreateDocumentRequest.Builder	ownerType(Number value)	Set Owner's user type, which can be 0: user, 1: company
String	parentId()	Get Id of a folder to place the created document in
DocumentsCreateDocumentRequest.Builder	parentId(String value)	Set Id of a folder to place the created document in
String[]	tags()	Get Onshape internal use
DocumentsCreateDocumentRequest.Builder	tags(String[] value)	Set Onshape internal use

Methods inherited from class java.lang.Object

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

Method Detail

name

public final String name()

Get Document name

Returns:

Document name

name

public final DocumentsCreateDocumentRequest.Builder name(String value)

Set Document name

Parameters:

value - Document name

Returns:

the Builder object.

parentId

public final String parentId()

Get Id of a folder to place the created document in

Returns:

Id of a folder to place the created document in

parentId

public final DocumentsCreateDocumentRequest.Builder parentId(String value)

Set Id of a folder to place the created document in

Parameters:

value - Id of a folder to place the created document in

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

ownerType

public final Number ownerType()

Get Owner's user type, which can be 0: user, 1: company

Returns:

Owner's user type, which can be 0: user, 1: company

ownerType

public final DocumentsCreateDocumentRequest.Builder ownerType(Number value)

Set Owner's user type, which can be 0: user, 1: company

Parameters:

value - Owner's user type, which can be 0: user, 1: company

Returns:

the Builder object.

betaCapabilityIds

public final String[] betaCapabilityIds()

Get Onshape internal use

Returns:

Onshape internal use

betaCapabilityIds

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

Set Onshape internal use

Parameters:

value - Onshape internal use

Returns:

the Builder object.

isPublic

public final Boolean isPublic()

Get Whether document is public

Returns:

Whether document is public

isPublic

public final DocumentsCreateDocumentRequest.Builder isPublic(Boolean value)

Set Whether document is public

Parameters:

value - Whether document is public

Returns:

the Builder object.

isGenerateUnknownMessages

public final Boolean isGenerateUnknownMessages()

Get Onshape internal use

Returns:

Onshape internal use

isGenerateUnknownMessages

public final DocumentsCreateDocumentRequest.Builder isGenerateUnknownMessages(Boolean value)

Set Onshape internal use

Parameters:

value - Onshape internal use

Returns:

the Builder object.

tags

public final String[] tags()

Get Onshape internal use

Returns:

Onshape internal use

tags

public final DocumentsCreateDocumentRequest.Builder tags(String[] value)

Set Onshape internal use

Parameters:

value - Onshape internal use

Returns:

the Builder object.

elements

public final DocumentsCreateDocumentRequestElements[] elements()

Get custom elements definition to be created with document.

Returns:

custom elements definition to be created with document.

elements

public final DocumentsCreateDocumentRequest.Builder elements(DocumentsCreateDocumentRequestElements[] value)

Set custom elements definition to be created with document.

Parameters:

value - custom elements definition to be created with document.

Returns:

the Builder object.

call

public final DocumentsCreateDocumentResponse call()
                                           throws OnshapeException

Calls createDocument method, Create document

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error