Class UnparsedNotification (2.5.0)

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
Name Description
messageNumber long

message number (a monotonically increasing value starting with 1)

resourceState String
resource state
resourceId String

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

resourceUri String

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

channelId String

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
Type Description
InputStream

getContentType()

public final String getContentType()

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

Returns
Type Description
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
Name Description
changed String
Returns
Type Description
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
Name Description
channelExpiration String
Returns
Type Description
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
Name Description
channelId String
Returns
Type Description
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
Name Description
channelToken String
Returns
Type Description
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
Name Description
contentStream InputStream
Returns
Type Description
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
Name Description
contentType String
Returns
Type Description
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
Name Description
messageNumber long
Returns
Type Description
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
Name Description
resourceId String
Returns
Type Description
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
Name Description
resourceState String
Returns
Type Description
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
Name Description
resourceUri String
Returns
Type Description
UnparsedNotification
Overrides

toString()

public String toString()
Returns
Type Description
String
Overrides