Class UnparsedNotification (1.35.2)

public class UnparsedNotification extends AbstractNotification

Beta
Notification metadata and unparsed content stream sent to this client about a watched resource.

Implementation is not thread-safe.

Inheritance

java.lang.Object > AbstractNotification > UnparsedNotification

Constructors

UnparsedNotification(long messageNumber, String resourceState, String resourceId, String resourceUri, String channelId)

public UnparsedNotification(long messageNumber, String resourceState, String resourceId, String resourceUri, String channelId)
Parameters
NameDescription
messageNumberlong

message number (a monotonically increasing value starting with 1)

resourceStateString
resource state
resourceIdString

opaque ID for the watched resource that is stable across API versions

resourceUriString

opaque ID (in the form of a canonicalized URI) for the watched resource that is sensitive to the API version

channelIdString

notification channel UUID provided by the client in the watch request

Methods

getContentStream()

public final InputStream getContentStream()

Returns the notification content input stream or null for none.

Returns
TypeDescription
InputStream

getContentType()

public final String getContentType()

Returns the notification content media type for the content stream or null for none or unknown.

Returns
TypeDescription
String

setChanged(String changed)

public UnparsedNotification setChanged(String changed)

Sets the type of change performed on the resource or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
changedString
Returns
TypeDescription
UnparsedNotification
Overrides

setChannelExpiration(String channelExpiration)

public UnparsedNotification setChannelExpiration(String channelExpiration)

Sets the notification channel expiration time or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
channelExpirationString
Returns
TypeDescription
UnparsedNotification
Overrides

setChannelId(String channelId)

public UnparsedNotification setChannelId(String channelId)

Sets the notification channel UUID provided by the client in the watch request.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
channelIdString
Returns
TypeDescription
UnparsedNotification
Overrides

setChannelToken(String channelToken)

public UnparsedNotification setChannelToken(String channelToken)

Sets the notification channel token (an opaque string) provided by the client in the watch request or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
channelTokenString
Returns
TypeDescription
UnparsedNotification
Overrides

setContentStream(InputStream contentStream)

public UnparsedNotification setContentStream(InputStream contentStream)

Sets the notification content content input stream or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
contentStreamInputStream
Returns
TypeDescription
UnparsedNotification

setContentType(String contentType)

public UnparsedNotification setContentType(String contentType)

Sets the notification content media type for the content stream or null for none or unknown.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
contentTypeString
Returns
TypeDescription
UnparsedNotification

setMessageNumber(long messageNumber)

public UnparsedNotification setMessageNumber(long messageNumber)

Sets the message number (a monotonically increasing value starting with 1).

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
messageNumberlong
Returns
TypeDescription
UnparsedNotification
Overrides

setResourceId(String resourceId)

public UnparsedNotification setResourceId(String resourceId)

Sets the opaque ID for the watched resource that is stable across API versions.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
resourceIdString
Returns
TypeDescription
UnparsedNotification
Overrides

setResourceState(String resourceState)

public UnparsedNotification setResourceState(String resourceState)

Sets the resource state.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
resourceStateString
Returns
TypeDescription
UnparsedNotification
Overrides

setResourceUri(String resourceUri)

public UnparsedNotification setResourceUri(String resourceUri)

Sets the opaque ID (in the form of a canonicalized URI) for the watched resource that is sensitive to the API version.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
NameDescription
resourceUriString
Returns
TypeDescription
UnparsedNotification
Overrides

toString()

public String toString()
Returns
TypeDescription
String
Overrides