All Superinterfaces:: com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:: Meta.WatchResponse, Meta.WatchResponse.Builder

Enclosing class:: Meta

public static interface Meta.WatchResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type

Method

Description

boolean

getCanceled()

canceled is set to true if the response is for a cancel watch request.

String

getCancelReason()

cancel_reason indicates the reason for canceling the watcher.

com.google.protobuf.ByteString

getCancelReasonBytes()

cancel_reason indicates the reason for canceling the watcher.

long

getCompactRevision()

compact_revision is set to the minimum index if a watcher tries to watch at a compacted index.

boolean

getCreated()

created is set to true if the response is for a create watch request.

ErrorOuterClass.Error

getError()

.dingodb.pb.error.Error error = 2;

ErrorOuterClass.ErrorOrBuilder

getErrorOrBuilder()

.dingodb.pb.error.Error error = 2;

Meta.MetaEvent

getEvents(int index)

the events may be empty or more than one, the client should handle the events if the events is empty, this means the response may be a probe response client can ignore the response if the events is empty, and continue to progress watch until the watch_id is canceled ( EWATCH_NOT_EXIST will be returned if the watch_id is canceled)

int

getEventsCount()

the events may be empty or more than one, the client should handle the events if the events is empty, this means the response may be a probe response client can ignore the response if the events is empty, and continue to progress watch until the watch_id is canceled ( EWATCH_NOT_EXIST will be returned if the watch_id is canceled)

List<Meta.MetaEvent>

getEventsList()

the events may be empty or more than one, the client should handle the events if the events is empty, this means the response may be a probe response client can ignore the response if the events is empty, and continue to progress watch until the watch_id is canceled ( EWATCH_NOT_EXIST will be returned if the watch_id is canceled)

Meta.MetaEventOrBuilder

getEventsOrBuilder(int index)

the events may be empty or more than one, the client should handle the events if the events is empty, this means the response may be a probe response client can ignore the response if the events is empty, and continue to progress watch until the watch_id is canceled ( EWATCH_NOT_EXIST will be returned if the watch_id is canceled)

List<? extends Meta.MetaEventOrBuilder>

getEventsOrBuilderList()

the events may be empty or more than one, the client should handle the events if the events is empty, this means the response may be a probe response client can ignore the response if the events is empty, and continue to progress watch until the watch_id is canceled ( EWATCH_NOT_EXIST will be returned if the watch_id is canceled)

Common.ResponseInfo

getResponseInfo()

.dingodb.pb.common.ResponseInfo response_info = 1;

Common.ResponseInfoOrBuilder

getResponseInfoOrBuilder()

.dingodb.pb.common.ResponseInfo response_info = 1;

long

getWatchId()

watch_id is the ID of the watcher that corresponds to the response.

boolean

hasError()

.dingodb.pb.error.Error error = 2;

boolean

hasResponseInfo()

.dingodb.pb.common.ResponseInfo response_info = 1;

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

hasResponseInfo

boolean hasResponseInfo()

.dingodb.pb.common.ResponseInfo response_info = 1;

Returns:

Whether the responseInfo field is set.
getResponseInfo

Common.ResponseInfo getResponseInfo()

.dingodb.pb.common.ResponseInfo response_info = 1;

Returns:

The responseInfo.
getResponseInfoOrBuilder

Common.ResponseInfoOrBuilder getResponseInfoOrBuilder()

.dingodb.pb.common.ResponseInfo response_info = 1;
hasError

boolean hasError()

.dingodb.pb.error.Error error = 2;

Returns:

Whether the error field is set.
getError

ErrorOuterClass.Error getError()

.dingodb.pb.error.Error error = 2;

Returns:

The error.
getErrorOrBuilder

ErrorOuterClass.ErrorOrBuilder getErrorOrBuilder()

.dingodb.pb.error.Error error = 2;

getWatchId

long getWatchId()

 watch_id is the ID of the watcher that corresponds to the response.

int64 watch_id = 4;

Returns:: The watchId.

getCreated

boolean getCreated()

 created is set to true if the response is for a create watch request.
 The client should record the watch_id and expect to receive events for
 the created watcher from the same stream.
 All events sent to the created watcher will attach with the same watch_id.

bool created = 5;

Returns:: The created.

getCanceled

boolean getCanceled()

 canceled is set to true if the response is for a cancel watch request.
 No further events will be sent to the canceled watcher.

bool canceled = 6;

Returns:: The canceled.

getCompactRevision

long getCompactRevision()

 compact_revision is set to the minimum index if a watcher tries to watch
 at a compacted index.

 This happens when creating a watcher at a compacted revision or the watcher cannot
 catch up with the progress of the key-value store.

 The client should treat the watcher as canceled and should not try to create any
 watcher with the same start_revision again.

int64 compact_revision = 7;

Returns:: The compactRevision.

getCancelReason

String getCancelReason()
```
 cancel_reason indicates the reason for canceling the watcher.
 
```
string cancel_reason = 8;
Returns:

The cancelReason.
getCancelReasonBytes

com.google.protobuf.ByteString getCancelReasonBytes()
```
 cancel_reason indicates the reason for canceling the watcher.
 
```
string cancel_reason = 8;
Returns:

The bytes for cancelReason.