Package s2.v1alpha

Class ReadSessionRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

s2.v1alpha.ReadSessionRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, ReadSessionRequestOrBuilder

public final class ReadSessionRequest
extends com.google.protobuf.GeneratedMessage
implements ReadSessionRequestOrBuilder

 Read session request.
 

Protobuf type s2.v1alpha.ReadSessionRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadSessionRequest.Builder	Read session request.
static class	ReadSessionRequest.StartCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	HEARTBEATS_FIELD_NUMBER
static int	LIMIT_FIELD_NUMBER
static int	SEQ_NUM_FIELD_NUMBER
static int	STREAM_FIELD_NUMBER
static int	TAIL_OFFSET_FIELD_NUMBER
static int	TIMESTAMP_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static ReadSessionRequest	getDefaultInstance()
ReadSessionRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getHeartbeats()	Heartbeats can be enabled to monitor end-to-end session health.
ReadLimit	getLimit()	Limit on how many records can be returned.
ReadLimitOrBuilder	getLimitOrBuilder()	Limit on how many records can be returned.
com.google.protobuf.Parser<ReadSessionRequest>	getParserForType()
long	getSeqNum()	Sequence number.
int	getSerializedSize()
ReadSessionRequest.StartCase	getStartCase()
java.lang.String	getStream()	Stream name.
com.google.protobuf.ByteString	getStreamBytes()	Stream name.
long	getTailOffset()	Number of records before the tail, i.e.
long	getTimestamp()	Timestamp.
int	hashCode()
boolean	hasLimit()	Limit on how many records can be returned.
boolean	hasSeqNum()	Sequence number.
boolean	hasTailOffset()	Number of records before the tail, i.e.
boolean	hasTimestamp()	Timestamp.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ReadSessionRequest.Builder	newBuilder()
static ReadSessionRequest.Builder	newBuilder(ReadSessionRequest prototype)
ReadSessionRequest.Builder	newBuilderForType()
protected ReadSessionRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ReadSessionRequest	parseDelimitedFrom(java.io.InputStream input)
static ReadSessionRequest	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSessionRequest	parseFrom(byte[] data)
static ReadSessionRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSessionRequest	parseFrom(com.google.protobuf.ByteString data)
static ReadSessionRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSessionRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ReadSessionRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSessionRequest	parseFrom(java.io.InputStream input)
static ReadSessionRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReadSessionRequest	parseFrom(java.nio.ByteBuffer data)
static ReadSessionRequest	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ReadSessionRequest>	parser()
ReadSessionRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

STREAM_FIELD_NUMBER

public static final int STREAM_FIELD_NUMBER

See Also:

Constant Field Values

SEQ_NUM_FIELD_NUMBER

public static final int SEQ_NUM_FIELD_NUMBER

See Also:

Constant Field Values

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

TAIL_OFFSET_FIELD_NUMBER

public static final int TAIL_OFFSET_FIELD_NUMBER

See Also:

Constant Field Values

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER

See Also:

Constant Field Values

HEARTBEATS_FIELD_NUMBER

public static final int HEARTBEATS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getStartCase

public ReadSessionRequest.StartCase getStartCase()

Specified by:

getStartCase in interface ReadSessionRequestOrBuilder

getStream

public java.lang.String getStream()

 Stream name.
 

string stream = 1;

Specified by:

getStream in interface ReadSessionRequestOrBuilder

Returns:

The stream.

getStreamBytes

public com.google.protobuf.ByteString getStreamBytes()

 Stream name.
 

string stream = 1;

Specified by:

getStreamBytes in interface ReadSessionRequestOrBuilder

Returns:

The bytes for stream.

hasSeqNum

public boolean hasSeqNum()

 Sequence number.
 

uint64 seq_num = 2;

Specified by:

hasSeqNum in interface ReadSessionRequestOrBuilder

Returns:

Whether the seqNum field is set.

getSeqNum

public long getSeqNum()

 Sequence number.
 

uint64 seq_num = 2;

Specified by:

getSeqNum in interface ReadSessionRequestOrBuilder

Returns:

The seqNum.

hasTimestamp

public boolean hasTimestamp()

 Timestamp.
 

uint64 timestamp = 5;

Specified by:

hasTimestamp in interface ReadSessionRequestOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

public long getTimestamp()

 Timestamp.
 

uint64 timestamp = 5;

Specified by:

getTimestamp in interface ReadSessionRequestOrBuilder

Returns:

The timestamp.

hasTailOffset

public boolean hasTailOffset()

 Number of records before the tail, i.e. the next sequence number.
 

uint64 tail_offset = 6;

Specified by:

hasTailOffset in interface ReadSessionRequestOrBuilder

Returns:

Whether the tailOffset field is set.

getTailOffset

public long getTailOffset()

 Number of records before the tail, i.e. the next sequence number.
 

uint64 tail_offset = 6;

Specified by:

getTailOffset in interface ReadSessionRequestOrBuilder

Returns:

The tailOffset.

hasLimit

public boolean hasLimit()

 Limit on how many records can be returned. When a limit is specified, the session will be terminated as soon as
 the limit is met, or when the current tail of the stream is reached -- whichever occurs first.
 If no limit is specified, the session will remain open after catching up to the tail, and continue tailing as
 new messages are written to the stream.
 

.s2.v1alpha.ReadLimit limit = 3;

Specified by:

hasLimit in interface ReadSessionRequestOrBuilder

Returns:

Whether the limit field is set.

getLimit

public ReadLimit getLimit()

 Limit on how many records can be returned. When a limit is specified, the session will be terminated as soon as
 the limit is met, or when the current tail of the stream is reached -- whichever occurs first.
 If no limit is specified, the session will remain open after catching up to the tail, and continue tailing as
 new messages are written to the stream.
 

.s2.v1alpha.ReadLimit limit = 3;

Specified by:

getLimit in interface ReadSessionRequestOrBuilder

Returns:

The limit.

getLimitOrBuilder

public ReadLimitOrBuilder getLimitOrBuilder()

 Limit on how many records can be returned. When a limit is specified, the session will be terminated as soon as
 the limit is met, or when the current tail of the stream is reached -- whichever occurs first.
 If no limit is specified, the session will remain open after catching up to the tail, and continue tailing as
 new messages are written to the stream.
 

.s2.v1alpha.ReadLimit limit = 3;

Specified by:

getLimitOrBuilder in interface ReadSessionRequestOrBuilder

getHeartbeats

public boolean getHeartbeats()

 Heartbeats can be enabled to monitor end-to-end session health.
 A heartbeat will be sent when the initial switch to real-time tailing happens,
 as well as when no records are available at a randomized interval between 5 and 15 seconds.
 

bool heartbeats = 4;

Specified by:

getHeartbeats in interface ReadSessionRequestOrBuilder

Returns:

The heartbeats.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ReadSessionRequest parseFrom(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSessionRequest parseFrom(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSessionRequest parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSessionRequest parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSessionRequest parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSessionRequest parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReadSessionRequest parseFrom(java.io.InputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ReadSessionRequest parseFrom(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ReadSessionRequest parseDelimitedFrom(java.io.InputStream input)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ReadSessionRequest parseDelimitedFrom(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ReadSessionRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ReadSessionRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public ReadSessionRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ReadSessionRequest.Builder newBuilder()

newBuilder

public static ReadSessionRequest.Builder newBuilder(ReadSessionRequest prototype)

toBuilder

public ReadSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ReadSessionRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static ReadSessionRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ReadSessionRequest> parser()

getParserForType

public com.google.protobuf.Parser<ReadSessionRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public ReadSessionRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder