com.ibm.watson.speech_to_text.v1.model

Class RegisterCallbackOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.speech_to_text.v1.model.RegisterCallbackOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class RegisterCallbackOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The registerCallback options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegisterCallbackOptions.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	callbackUrl
protected java.lang.String	userSecret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegisterCallbackOptions(RegisterCallbackOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	callbackUrl() Gets the callbackUrl.
RegisterCallbackOptions.Builder	newBuilder() New builder.
java.lang.String	userSecret() Gets the userSecret.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

callbackUrl

protected java.lang.String callbackUrl

userSecret

protected java.lang.String userSecret

Constructor Detail

RegisterCallbackOptions

protected RegisterCallbackOptions(RegisterCallbackOptions.Builder builder)

Method Detail

newBuilder

public RegisterCallbackOptions.Builder newBuilder()

New builder.

Returns:

a RegisterCallbackOptions builder

callbackUrl

public java.lang.String callbackUrl()

Gets the callbackUrl.

An HTTP or HTTPS URL to which callback notifications are to be sent. To be allowlisted, the URL must successfully echo the challenge string during URL verification. During verification, the client can also check the signature that the service sends in the `X-Callback-Signature` header to verify the origin of the request.

Returns:

the callbackUrl

userSecret

public java.lang.String userSecret()

Gets the userSecret.

A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the `X-Callback-Signature` header. The service includes the header during URL verification and with every notification sent to the callback URL. It calculates the signature over the payload of the notification. If you omit the parameter, the service does not send the header.

Returns:

the userSecret