Package com.onshape.api.requests

Class WebhooksCreateWebhookRequest.Builder

java.lang.Object

com.onshape.api.requests.WebhooksCreateWebhookRequest.Builder

Enclosing class:

WebhooksCreateWebhookRequest

public static final class WebhooksCreateWebhookRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
WebhooksCreateWebhookResponse	call()	Calls createWebhook method, Create a webhook, which functions like an event listener
String	data()	Get Data to encapsulate in webhook
WebhooksCreateWebhookRequest.Builder	data(String value)	Set Data to encapsulate in webhook
String[]	events()	Get Array of event names for which to register webhook
WebhooksCreateWebhookRequest.Builder	events(String[] value)	Set Array of event names for which to register webhook
String	filter()	Get Context for webhook, in one of two forms: "{DocumentId} = '[did]' && {WorkspaceId} = '[wid]' && {ElementId} = '[eid]'" or "{UserId} = '[uid]' && {ClientId} = 'cid'" [did] is a document ID, etc., but the components in brackets and the quotes must remain exactly as written, in the same order
WebhooksCreateWebhookRequest.Builder	filter(String value)	Set Context for webhook, in one of two forms: "{DocumentId} = '[did]' && {WorkspaceId} = '[wid]' && {ElementId} = '[eid]'" or "{UserId} = '[uid]' && {ClientId} = 'cid'" [did] is a document ID, etc., but the components in brackets and the quotes must remain exactly as written, in the same order
Map	options()	Get Options object, with one optional field: collapseEvents, which is set to true/false and says whether similar events should be collapsed into one notification
WebhooksCreateWebhookRequest.Builder	options(Map value)	Set Options object, with one optional field: collapseEvents, which is set to true/false and says whether similar events should be collapsed into one notification
String	url()	Get URL to which to send notifications
WebhooksCreateWebhookRequest.Builder	url(String value)	Set URL to which to send notifications

Methods inherited from class java.lang.Object

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

Method Detail

url

public final String url()

Get URL to which to send notifications

Returns:

URL to which to send notifications

url

public final WebhooksCreateWebhookRequest.Builder url(String value)

Set URL to which to send notifications

Parameters:

value - URL to which to send notifications

Returns:

the Builder object.

events

public final String[] events()

Get Array of event names for which to register webhook

Returns:

Array of event names for which to register webhook

events

public final WebhooksCreateWebhookRequest.Builder events(String[] value)

Set Array of event names for which to register webhook

Parameters:

value - Array of event names for which to register webhook

Returns:

the Builder object.

filter

public final String filter()

Get Context for webhook, in one of two forms: "{DocumentId} = '[did]' && {WorkspaceId} = '[wid]' && {ElementId} = '[eid]'" or "{UserId} = '[uid]' && {ClientId} = 'cid'" [did] is a document ID, etc., but the components in brackets and the quotes must remain exactly as written, in the same order

Returns:

Context for webhook, in one of two forms: "{DocumentId} = '[did]' && {WorkspaceId} = '[wid]' && {ElementId} = '[eid]'" or "{UserId} = '[uid]' && {ClientId} = 'cid'" [did] is a document ID, etc., but the components in brackets and the quotes must remain exactly as written, in the same order

filter

public final WebhooksCreateWebhookRequest.Builder filter(String value)

Set Context for webhook, in one of two forms: "{DocumentId} = '[did]' && {WorkspaceId} = '[wid]' && {ElementId} = '[eid]'" or "{UserId} = '[uid]' && {ClientId} = 'cid'" [did] is a document ID, etc., but the components in brackets and the quotes must remain exactly as written, in the same order

Parameters:

value - Context for webhook, in one of two forms: "{DocumentId} = '[did]' && {WorkspaceId} = '[wid]' && {ElementId} = '[eid]'" or "{UserId} = '[uid]' && {ClientId} = 'cid'" [did] is a document ID, etc., but the components in brackets and the quotes must remain exactly as written, in the same order

Returns:

the Builder object.

options

public final Map options()

Get Options object, with one optional field: collapseEvents, which is set to true/false and says whether similar events should be collapsed into one notification

Returns:

Options object, with one optional field: collapseEvents, which is set to true/false and says whether similar events should be collapsed into one notification

options

public final WebhooksCreateWebhookRequest.Builder options(Map value)

Set Options object, with one optional field: collapseEvents, which is set to true/false and says whether similar events should be collapsed into one notification

Parameters:

value - Options object, with one optional field: collapseEvents, which is set to true/false and says whether similar events should be collapsed into one notification

Returns:

the Builder object.

data

public final String data()

Get Data to encapsulate in webhook

Returns:

Data to encapsulate in webhook

data

public final WebhooksCreateWebhookRequest.Builder data(String value)

Set Data to encapsulate in webhook

Parameters:

value - Data to encapsulate in webhook

Returns:

the Builder object.

call

public final WebhooksCreateWebhookResponse call()
                                         throws OnshapeException

Calls createWebhook method, Create a webhook, which functions like an event listener

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error