Package com.onshape.api.requests

Class CommentsCreateRequest.Builder

java.lang.Object

com.onshape.api.requests.CommentsCreateRequest.Builder

Enclosing class:

CommentsCreateRequest

public static final class CommentsCreateRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
String	assemblyFeature()	Get id of an assembly feature, with the owner occurrence path id prepended.
CommentsCreateRequest.Builder	assemblyFeature(String value)	Set id of an assembly feature, with the owner occurrence path id prepended.
String	assignee()	Get the user this comment is assigned to.
CommentsCreateRequest.Builder	assignee(String value)	Set the user this comment is assigned to.
CommentsCreateResponse	call()	Calls create method, Post a new comment to a document
String	documentId()	Get id of the document to comment on.
CommentsCreateRequest.Builder	documentId(String value)	Set id of the document to comment on.
String	elementFeature()	Get id of an element feature.
CommentsCreateRequest.Builder	elementFeature(String value)	Set id of an element feature.
String	elementId()	Get id of the element.
CommentsCreateRequest.Builder	elementId(String value)	Set id of the element.
String	elementOccurrence()	Get id of an assembly occurrence.
CommentsCreateRequest.Builder	elementOccurrence(String value)	Set id of an assembly occurrence.
String	elementQuery()	Get query to get element parts like face.
CommentsCreateRequest.Builder	elementQuery(String value)	Set query to get element parts like face.
String	message()	Get Raw text for the comment.
CommentsCreateRequest.Builder	message(String value)	Set Raw text for the comment.
String	parentId()	Get id of the parent comment in case this is a reply.
CommentsCreateRequest.Builder	parentId(String value)	Set id of the parent comment in case this is a reply.
String	versionId()	Get id of the version to comment on.
CommentsCreateRequest.Builder	versionId(String value)	Set id of the version to comment on.
CommentsCreateRequestViewData	viewData()	Get camera view data associated with this comment.
CommentsCreateRequest.Builder	viewData(CommentsCreateRequestViewData value)	Set camera view data associated with this comment.
String	workspaceId()	Get id of the document workspace to comment on.
CommentsCreateRequest.Builder	workspaceId(String value)	Set id of the document workspace to comment on.

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 id of the document to comment on.

Returns:

id of the document to comment on.

documentId

public final CommentsCreateRequest.Builder documentId(String value)

Set id of the document to comment on.

Parameters:

value - id of the document to comment on.

Returns:

the Builder object.

workspaceId

public final String workspaceId()

Get id of the document workspace to comment on. Optional field.

Returns:

id of the document workspace to comment on. Optional field.

workspaceId

public final CommentsCreateRequest.Builder workspaceId(String value)

Set id of the document workspace to comment on. Optional field.

Parameters:

value - id of the document workspace to comment on. Optional field.

Returns:

the Builder object.

versionId

public final String versionId()

Get id of the version to comment on. Optional field.

Returns:

id of the version to comment on. Optional field.

versionId

public final CommentsCreateRequest.Builder versionId(String value)

Set id of the version to comment on. Optional field.

Parameters:

value - id of the version to comment on. Optional field.

Returns:

the Builder object.

parentId

public final String parentId()

Get id of the parent comment in case this is a reply.

Returns:

id of the parent comment in case this is a reply.

parentId

public final CommentsCreateRequest.Builder parentId(String value)

Set id of the parent comment in case this is a reply.

Parameters:

value - id of the parent comment in case this is a reply.

Returns:

the Builder object.

message

public final String message()

Get Raw text for the comment.

Returns:

Raw text for the comment.

message

public final CommentsCreateRequest.Builder message(String value)

Set Raw text for the comment.

Parameters:

value - Raw text for the comment.

Returns:

the Builder object.

elementId

public final String elementId()

Get id of the element.

Returns:

id of the element.

elementId

public final CommentsCreateRequest.Builder elementId(String value)

Set id of the element.

Parameters:

value - id of the element.

Returns:

the Builder object.

elementQuery

public final String elementQuery()

Get query to get element parts like face.

Returns:

query to get element parts like face.

elementQuery

public final CommentsCreateRequest.Builder elementQuery(String value)

Set query to get element parts like face.

Parameters:

value - query to get element parts like face.

Returns:

the Builder object.

elementFeature

public final String elementFeature()

Get id of an element feature.

Returns:

id of an element feature.

elementFeature

public final CommentsCreateRequest.Builder elementFeature(String value)

Set id of an element feature.

Parameters:

value - id of an element feature.

Returns:

the Builder object.

elementOccurrence

public final String elementOccurrence()

Get id of an assembly occurrence.

Returns:

id of an assembly occurrence.

elementOccurrence

public final CommentsCreateRequest.Builder elementOccurrence(String value)

Set id of an assembly occurrence.

Parameters:

value - id of an assembly occurrence.

Returns:

the Builder object.

assemblyFeature

public final String assemblyFeature()

Get id of an assembly feature, with the owner occurrence path id prepended.

Returns:

id of an assembly feature, with the owner occurrence path id prepended.

assemblyFeature

public final CommentsCreateRequest.Builder assemblyFeature(String value)

Set id of an assembly feature, with the owner occurrence path id prepended.

Parameters:

value - id of an assembly feature, with the owner occurrence path id prepended.

Returns:

the Builder object.

viewData

public final CommentsCreateRequestViewData viewData()

Get camera view data associated with this comment.

Returns:

camera view data associated with this comment.

viewData

public final CommentsCreateRequest.Builder viewData(CommentsCreateRequestViewData value)

Set camera view data associated with this comment.

Parameters:

value - camera view data associated with this comment.

Returns:

the Builder object.

assignee

public final String assignee()

Get the user this comment is assigned to.

Returns:

the user this comment is assigned to.

assignee

public final CommentsCreateRequest.Builder assignee(String value)

Set the user this comment is assigned to.

Parameters:

value - the user this comment is assigned to.

Returns:

the Builder object.

call

public final CommentsCreateResponse call()
                                  throws OnshapeException

Calls create method, Post a new comment to a document

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error