Package com.onshape.api.requests

Class WebhooksUpdateWebhookRequest.Builder

java.lang.Object

com.onshape.api.requests.WebhooksUpdateWebhookRequest.Builder

Enclosing class:

WebhooksUpdateWebhookRequest

public static final class WebhooksUpdateWebhookRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
WebhooksUpdateWebhookResponse	call(String webhookid)	Calls updateWebhook method, Update a webhook
String	data()	Get Data to encapsulate in webhook
WebhooksUpdateWebhookRequest.Builder	data(String value)	Set Data to encapsulate in webhook
String[]	events()	Get Array of event names for which to register webhook
WebhooksUpdateWebhookRequest.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
WebhooksUpdateWebhookRequest.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
String	id()	Get ID of webhook to update (must match webhookid in path parameter)
WebhooksUpdateWebhookRequest.Builder	id(String value)	Set ID of webhook to update (must match webhookid in path parameter)
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
WebhooksUpdateWebhookRequest.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
WebhooksUpdateWebhookRequest.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

id

public final String id()

Get ID of webhook to update (must match webhookid in path parameter)

Returns:

ID of webhook to update (must match webhookid in path parameter)

id

public final WebhooksUpdateWebhookRequest.Builder id(String value)

Set ID of webhook to update (must match webhookid in path parameter)

Parameters:

value - ID of webhook to update (must match webhookid in path parameter)

Returns:

the Builder object.

url

public final String url()

Get URL to which to send notifications

Returns:

URL to which to send notifications

url

public final WebhooksUpdateWebhookRequest.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 WebhooksUpdateWebhookRequest.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 WebhooksUpdateWebhookRequest.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 WebhooksUpdateWebhookRequest.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 WebhooksUpdateWebhookRequest.Builder data(String value)

Set Data to encapsulate in webhook

Parameters:

value - Data to encapsulate in webhook

Returns:

the Builder object.

call

public final WebhooksUpdateWebhookResponse call(String webhookid)
                                         throws OnshapeException

Calls updateWebhook method, Update a webhook

Parameters:

webhookid - ID of webhook to update

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error