Package com.onshape.api.requests

Class AppElementsGetSubElementContentRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsGetSubElementContentRequest.Builder

Enclosing class:

AppElementsGetSubElementContentRequest

public static final class AppElementsGetSubElementContentRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
String	baseChangeId()	Get Id of a change made prior to the specified or implied changeId.
AppElementsGetSubElementContentRequest.Builder	baseChangeId(String value)	Set Id of a change made prior to the specified or implied changeId.
AppElementsGetSubElementContentResponse	call(OnshapeDocument document)	Calls getSubElementContent method, Get content of sub-elements in a workspace
AppElementsGetSubElementContentResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getSubElementContent method, Get content of sub-elements in a workspace
String	changeId()	Get Id of the change at which the ids should be retrieved.
AppElementsGetSubElementContentRequest.Builder	changeId(String value)	Set Id of the change at which the ids should be retrieved.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
AppElementsGetSubElementContentRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
String	subelementId()	Get Id of a sub-element to use as a restriction for returned data
AppElementsGetSubElementContentRequest.Builder	subelementId(String value)	Set Id of a sub-element to use as a restriction for returned data
String	transactionId()	Get Id of the transaction in which the ids should be retrieved.
AppElementsGetSubElementContentRequest.Builder	transactionId(String value)	Set Id of the transaction in which the ids should be retrieved.

Methods inherited from class java.lang.Object

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

Method Detail

transactionId

public final String transactionId()

Get Id of the transaction in which the ids should be retrieved. Valid only when used with a workspaceId

Returns:

Id of the transaction in which the ids should be retrieved. Valid only when used with a workspaceId

transactionId

public final AppElementsGetSubElementContentRequest.Builder transactionId(String value)

Set Id of the transaction in which the ids should be retrieved. Valid only when used with a workspaceId

Parameters:

value - Id of the transaction in which the ids should be retrieved. Valid only when used with a workspaceId

Returns:

the Builder object.

changeId

public final String changeId()

Get Id of the change at which the ids should be retrieved. If not specified, defaults to the latest change in the workspace, version or microversion. May be specified only when used with a workspaceId

Returns:

Id of the change at which the ids should be retrieved. If not specified, defaults to the latest change in the workspace, version or microversion. May be specified only when used with a workspaceId

changeId

public final AppElementsGetSubElementContentRequest.Builder changeId(String value)

Set Id of the change at which the ids should be retrieved. If not specified, defaults to the latest change in the workspace, version or microversion. May be specified only when used with a workspaceId

Parameters:

value - Id of the change at which the ids should be retrieved. If not specified, defaults to the latest change in the workspace, version or microversion. May be specified only when used with a workspaceId

Returns:

the Builder object.

baseChangeId

public final String baseChangeId()

Get Id of a change made prior to the specified or implied changeId. If specified, only changes made after the base changeId are returned.

Returns:

Id of a change made prior to the specified or implied changeId. If specified, only changes made after the base changeId are returned.

baseChangeId

public final AppElementsGetSubElementContentRequest.Builder baseChangeId(String value)

Set Id of a change made prior to the specified or implied changeId. If specified, only changes made after the base changeId are returned.

Parameters:

value - Id of a change made prior to the specified or implied changeId. If specified, only changes made after the base changeId are returned.

Returns:

the Builder object.

subelementId

public final String subelementId()

Get Id of a sub-element to use as a restriction for returned data

Returns:

Id of a sub-element to use as a restriction for returned data

subelementId

public final AppElementsGetSubElementContentRequest.Builder subelementId(String value)

Set Id of a sub-element to use as a restriction for returned data

Parameters:

value - Id of a sub-element to use as a restriction for returned data

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final AppElementsGetSubElementContentRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

call

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

Calls getSubElementContent method, Get content of sub-elements in a workspace

Parameters:

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 AppElementsGetSubElementContentResponse call(OnshapeDocument document)
                                                   throws OnshapeException

Calls getSubElementContent method, Get content of sub-elements in a workspace

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error