Package com.onshape.api.requests

Class DocumentsCreateVersionRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsCreateVersionRequest.Builder

Enclosing class:

DocumentsCreateVersionRequest

public static final class DocumentsCreateVersionRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsCreateVersionResponse	call(OnshapeDocument document)	Calls createVersion method, Create version at the current microversion of the specified workspace or a target microversion.
DocumentsCreateVersionResponse	call(String did)	Calls createVersion method, Create version at the current microversion of the specified workspace or a target microversion.
String	description()	Get Version description
DocumentsCreateVersionRequest.Builder	description(String value)	Set Version description
String	documentId()	Get Document ID (must match path parameter)
DocumentsCreateVersionRequest.Builder	documentId(String value)	Set Document ID (must match path parameter)
Boolean	fromHistory()	Get Specifies whether to create a version at a specific microversion (specified by microversionId)
DocumentsCreateVersionRequest.Builder	fromHistory(Boolean value)	Set Specifies whether to create a version at a specific microversion (specified by microversionId)
String	microversionId()	Get Microversion ID at which to create the version if fromHistory is true
DocumentsCreateVersionRequest.Builder	microversionId(String value)	Set Microversion ID at which to create the version if fromHistory is true
String	name()	Get Version name
DocumentsCreateVersionRequest.Builder	name(String value)	Set Version name
String	workspaceId()	Get Workspace ID of a workspace where the version will be created if fromHistory is false.
DocumentsCreateVersionRequest.Builder	workspaceId(String value)	Set Workspace ID of a workspace where the version will be created if fromHistory is false.

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 Document ID (must match path parameter)

Returns:

Document ID (must match path parameter)

documentId

public final DocumentsCreateVersionRequest.Builder documentId(String value)

Set Document ID (must match path parameter)

Parameters:

value - Document ID (must match path parameter)

Returns:

the Builder object.

workspaceId

public final String workspaceId()

Get Workspace ID of a workspace where the version will be created if fromHistory is false. If fromHistory is false and workspaceId is not set, the default workspace is used.

Returns:

Workspace ID of a workspace where the version will be created if fromHistory is false. If fromHistory is false and workspaceId is not set, the default workspace is used.

workspaceId

public final DocumentsCreateVersionRequest.Builder workspaceId(String value)

Set Workspace ID of a workspace where the version will be created if fromHistory is false. If fromHistory is false and workspaceId is not set, the default workspace is used.

Parameters:

value - Workspace ID of a workspace where the version will be created if fromHistory is false. If fromHistory is false and workspaceId is not set, the default workspace is used.

Returns:

the Builder object.

name

public final String name()

Get Version name

Returns:

Version name

name

public final DocumentsCreateVersionRequest.Builder name(String value)

Set Version name

Parameters:

value - Version name

Returns:

the Builder object.

description

public final String description()

Get Version description

Returns:

Version description

description

public final DocumentsCreateVersionRequest.Builder description(String value)

Set Version description

Parameters:

value - Version description

Returns:

the Builder object.

microversionId

public final String microversionId()

Get Microversion ID at which to create the version if fromHistory is true

Returns:

Microversion ID at which to create the version if fromHistory is true

microversionId

public final DocumentsCreateVersionRequest.Builder microversionId(String value)

Set Microversion ID at which to create the version if fromHistory is true

Parameters:

value - Microversion ID at which to create the version if fromHistory is true

Returns:

the Builder object.

fromHistory

public final Boolean fromHistory()

Get Specifies whether to create a version at a specific microversion (specified by microversionId)

Returns:

Specifies whether to create a version at a specific microversion (specified by microversionId)

fromHistory

public final DocumentsCreateVersionRequest.Builder fromHistory(Boolean value)

Set Specifies whether to create a version at a specific microversion (specified by microversionId)

Parameters:

value - Specifies whether to create a version at a specific microversion (specified by microversionId)

Returns:

the Builder object.

call

public final DocumentsCreateVersionResponse call(String did)
                                          throws OnshapeException

Calls createVersion method, Create version at the current microversion of the specified workspace or a target microversion. Versions should be created only for tracking the state of a document that will need to be referenced by the user in the future. An application should not use versions as a convenience mechanism for an application to remember document states.

Parameters:

did - Document ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final DocumentsCreateVersionResponse call(OnshapeDocument document)
                                          throws OnshapeException

Calls createVersion method, Create version at the current microversion of the specified workspace or a target microversion. Versions should be created only for tracking the state of a document that will need to be referenced by the user in the future. An application should not use versions as a convenience mechanism for an application to remember document states.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error