Package com.onshape.api.requests

Class AppElementsDeleteContentRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsDeleteContentRequest.Builder

Enclosing class:

AppElementsDeleteContentRequest

public static final class AppElementsDeleteContentRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsDeleteContentResponse	call(OnshapeDocument document, String sid)	Calls deleteContent method, Deletes a sub-element of an application element
AppElementsDeleteContentResponse	call(String sid, String did, WVM wvmType, String wvm, String eid)	Calls deleteContent method, Deletes a sub-element of an application element
String	description()	Get Description of the deletion operation for history
AppElementsDeleteContentRequest.Builder	description(String value)	Set Description of the deletion operation for history
String	parentChangeId()	Get Id of the last change made by this application to this element
AppElementsDeleteContentRequest.Builder	parentChangeId(String value)	Set Id of the last change made by this application to this element
String	transactionId()	Get Id of the transaction to commit
AppElementsDeleteContentRequest.Builder	transactionId(String value)	Set Id of the transaction to commit

Methods inherited from class java.lang.Object

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

Method Detail

parentChangeId

public final String parentChangeId()

Get Id of the last change made by this application to this element

Returns:

Id of the last change made by this application to this element

parentChangeId

public final AppElementsDeleteContentRequest.Builder parentChangeId(String value)

Set Id of the last change made by this application to this element

Parameters:

value - Id of the last change made by this application to this element

Returns:

the Builder object.

transactionId

public final String transactionId()

Get Id of the transaction to commit

Returns:

Id of the transaction to commit

transactionId

public final AppElementsDeleteContentRequest.Builder transactionId(String value)

Set Id of the transaction to commit

Parameters:

value - Id of the transaction to commit

Returns:

the Builder object.

description

public final String description()

Get Description of the deletion operation for history

Returns:

Description of the deletion operation for history

description

public final AppElementsDeleteContentRequest.Builder description(String value)

Set Description of the deletion operation for history

Parameters:

value - Description of the deletion operation for history

Returns:

the Builder object.

call

public final AppElementsDeleteContentResponse call(String sid,
                                                   String did,
                                                   WVM wvmType,
                                                   String wvm,
                                                   String eid)
                                            throws OnshapeException

Calls deleteContent method, Deletes a sub-element of an application element

Parameters:

sid - The id of the subelement to be deleted. URL-encode if needed

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AppElementsDeleteContentResponse call(OnshapeDocument document,
                                                   String sid)
                                            throws OnshapeException

Calls deleteContent method, Deletes a sub-element of an application element

Parameters:

document - Document object from Onshape URL.

sid - The id of the subelement to be deleted. URL-encode if needed

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error