AppElementsCreateReferenceRequest.Builder (api-client 1.137.27923.860f36b32a5a API)

java.lang.Object
- com.onshape.api.requests.AppElementsCreateReferenceRequest.Builder

Enclosing class:: AppElementsCreateReferenceRequest

public static final class AppElementsCreateReferenceRequest.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AppElementsCreateReferenceResponse`	`call(OnshapeDocument document)`	Calls createReference method, Create an app element reference
`AppElementsCreateReferenceResponse`	`call(String did, String wid, String eid)`	Calls createReference method, Create an app element reference
`String`	`idTag()`	Get An optional deterministic id within the target element that should be tracked
`AppElementsCreateReferenceRequest.Builder`	`idTag(String value)`	Set An optional deterministic id within the target element that should be tracked
`String`	`idTagMicroversionId()`	Get If idTag is specified, the document microversion associated with the idTag
`AppElementsCreateReferenceRequest.Builder`	`idTagMicroversionId(String value)`	Set If idTag is specified, the document microversion associated with the idTag
`String`	`parentChangeId()`	Get Id of the prior change to the application element
`AppElementsCreateReferenceRequest.Builder`	`parentChangeId(String value)`	Set Id of the prior change to the application element
`String`	`sketchId()`	Get An optional sketch feature id within the target element that should be tracked
`AppElementsCreateReferenceRequest.Builder`	`sketchId(String value)`	Set An optional sketch feature id within the target element that should be tracked
`String`	`targetConfiguration()`	Get If not blank, specifies the configuration of the element.
`AppElementsCreateReferenceRequest.Builder`	`targetConfiguration(String value)`	Set If not blank, specifies the configuration of the element.
`String`	`targetDocumentId()`	Get The Id of the document of the element that is or contains the target of the reference
`AppElementsCreateReferenceRequest.Builder`	`targetDocumentId(String value)`	Set The Id of the document of the element that is or contains the target of the reference
`String`	`targetElementId()`	Get The element Id of the element that is or contains the target of the reference
`AppElementsCreateReferenceRequest.Builder`	`targetElementId(String value)`	Set The element Id of the element that is or contains the target of the reference
`String`	`targetMicroversionId()`	Get An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
`AppElementsCreateReferenceRequest.Builder`	`targetMicroversionId(String value)`	Set An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
`String`	`targetVersionId()`	Get The Id of the version the document that contains the target of the reference
`AppElementsCreateReferenceRequest.Builder`	`targetVersionId(String value)`	Set The Id of the version the document that contains the target of the reference
`String`	`transactionId()`	Get Id of the transaction in which the reference creation should occur
`AppElementsCreateReferenceRequest.Builder`	`transactionId(String value)`	Set Id of the transaction in which the reference creation should occur

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 reference creation should occur
    
    Returns:
    
    Id of the transaction in which the reference creation should occur
  - transactionId
```
public final AppElementsCreateReferenceRequest.Builder transactionId(String value)
```
    Set Id of the transaction in which the reference creation should occur
    
    Parameters:
    
    value - Id of the transaction in which the reference creation should occur
    
    Returns:
    
    the Builder object.
  - parentChangeId
```
public final String parentChangeId()
```
    Get Id of the prior change to the application element
    
    Returns:
    
    Id of the prior change to the application element
  - parentChangeId
```
public final AppElementsCreateReferenceRequest.Builder parentChangeId(String value)
```
    Set Id of the prior change to the application element
    
    Parameters:
    
    value - Id of the prior change to the application element
    
    Returns:
    
    the Builder object.
  - targetDocumentId
```
public final String targetDocumentId()
```
    Get The Id of the document of the element that is or contains the target of the reference
    
    Returns:
    
    The Id of the document of the element that is or contains the target of the reference
  - targetDocumentId
```
public final AppElementsCreateReferenceRequest.Builder targetDocumentId(String value)
```
    Set The Id of the document of the element that is or contains the target of the reference
    
    Parameters:
    
    value - The Id of the document of the element that is or contains the target of the reference
    
    Returns:
    
    the Builder object.
  - targetVersionId
```
public final String targetVersionId()
```
    Get The Id of the version the document that contains the target of the reference
    
    Returns:
    
    The Id of the version the document that contains the target of the reference
  - targetVersionId
```
public final AppElementsCreateReferenceRequest.Builder targetVersionId(String value)
```
    Set The Id of the version the document that contains the target of the reference
    
    Parameters:
    
    value - The Id of the version the document that contains the target of the reference
    
    Returns:
    
    the Builder object.
  - targetElementId
```
public final String targetElementId()
```
    Get The element Id of the element that is or contains the target of the reference
    
    Returns:
    
    The element Id of the element that is or contains the target of the reference
  - targetElementId
```
public final AppElementsCreateReferenceRequest.Builder targetElementId(String value)
```
    Set The element Id of the element that is or contains the target of the reference
    
    Parameters:
    
    value - The element Id of the element that is or contains the target of the reference
    
    Returns:
    
    the Builder object.
  - targetMicroversionId
```
public final String targetMicroversionId()
```
    Get An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
    
    Returns:
    
    An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
  - targetMicroversionId
```
public final AppElementsCreateReferenceRequest.Builder targetMicroversionId(String value)
```
    Set An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
    
    Parameters:
    
    value - An optional document microversionId that should be tracked, in case a specific point in history should be tracked by the reference
    
    Returns:
    
    the Builder object.
  - idTag
```
public final String idTag()
```
    Get An optional deterministic id within the target element that should be tracked
    
    Returns:
    
    An optional deterministic id within the target element that should be tracked
  - idTag
```
public final AppElementsCreateReferenceRequest.Builder idTag(String value)
```
    Set An optional deterministic id within the target element that should be tracked
    
    Parameters:
    
    value - An optional deterministic id within the target element that should be tracked
    
    Returns:
    
    the Builder object.
  - idTagMicroversionId
```
public final String idTagMicroversionId()
```
    Get If idTag is specified, the document microversion associated with the idTag
    
    Returns:
    
    If idTag is specified, the document microversion associated with the idTag
  - idTagMicroversionId
```
public final AppElementsCreateReferenceRequest.Builder idTagMicroversionId(String value)
```
    Set If idTag is specified, the document microversion associated with the idTag
    
    Parameters:
    
    value - If idTag is specified, the document microversion associated with the idTag
    
    Returns:
    
    the Builder object.
  - targetConfiguration
```
public final String targetConfiguration()
```
    Get If not blank, specifies the configuration of the element. Otherwise, the configuration is the default configuration for the element.
    
    Returns:
    
    If not blank, specifies the configuration of the element. Otherwise, the configuration is the default configuration for the element.
  - targetConfiguration
```
public final AppElementsCreateReferenceRequest.Builder targetConfiguration(String value)
```
    Set If not blank, specifies the configuration of the element. Otherwise, the configuration is the default configuration for the element.
    
    Parameters:
    
    value - If not blank, specifies the configuration of the element. Otherwise, the configuration is the default configuration for the element.
    
    Returns:
    
    the Builder object.
  - sketchId
```
public final String sketchId()
```
    Get An optional sketch feature id within the target element that should be tracked
    
    Returns:
    
    An optional sketch feature id within the target element that should be tracked
  - sketchId
```
public final AppElementsCreateReferenceRequest.Builder sketchId(String value)
```
    Set An optional sketch feature id within the target element that should be tracked
    
    Parameters:
    
    value - An optional sketch feature id within the target element that should be tracked
    
    Returns:
    
    the Builder object.
  - call
```
public final AppElementsCreateReferenceResponse call(String did,
                                                     String wid,
                                                     String eid)
                                              throws OnshapeException
```
    Calls createReference method, Create an app element reference
    
    Parameters:
    
    did - Document ID
    
    wid - Workspace ID
    
    eid - Element ID
    
    Returns:
    
    Response object
    
    Throws:
    
    OnshapeException - On HTTP or serialization error
  - call
```
public final AppElementsCreateReferenceResponse call(OnshapeDocument document)
                                              throws OnshapeException
```
    Calls createReference method, Create an app element reference
    
    Parameters:
    
    document - Document object from Onshape URL.
    
    Returns:
    
    Response object
    
    Throws:
    
    OnshapeException - On HTTP or serialization error

Class AppElementsCreateReferenceRequest.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

transactionId

transactionId

parentChangeId

parentChangeId

targetDocumentId

targetDocumentId

targetVersionId

targetVersionId

targetElementId

targetElementId

targetMicroversionId

targetMicroversionId

idTag

idTag

idTagMicroversionId

idTagMicroversionId

targetConfiguration

targetConfiguration

sketchId

sketchId

call

call