Package com.google.bigtable.v2
Class ReadChangeStreamRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.bigtable.v2.ReadChangeStreamRequest
- All Implemented Interfaces:
ReadChangeStreamRequestOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class ReadChangeStreamRequest
extends com.google.protobuf.GeneratedMessageV3
implements ReadChangeStreamRequestOrBuilder
NOTE: This API is intended to be used by Apache Beam BigtableIO. Request message for Bigtable.ReadChangeStream.Protobuf type
google.bigtable.v2.ReadChangeStreamRequest
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
NOTE: This API is intended to be used by Apache Beam BigtableIO.static enum
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
This value specifies routing for replication.com.google.protobuf.ByteString
This value specifies routing for replication.Tokens that describe how to resume reading a stream where reading previously left off.Tokens that describe how to resume reading a stream where reading previously left off.static ReadChangeStreamRequest
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Timestamp
If specified, OK will be returned when the stream advances beyond this time.com.google.protobuf.TimestampOrBuilder
If specified, OK will be returned when the stream advances beyond this time.com.google.protobuf.Duration
If specified, the duration between `Heartbeat` messages on the stream.com.google.protobuf.DurationOrBuilder
If specified, the duration between `Heartbeat` messages on the stream.com.google.protobuf.Parser<ReadChangeStreamRequest>
The partition to read changes from.The partition to read changes from.int
com.google.protobuf.Timestamp
Start reading the stream at the specified timestamp.com.google.protobuf.TimestampOrBuilder
Start reading the stream at the specified timestamp.Required.com.google.protobuf.ByteString
Required.boolean
Tokens that describe how to resume reading a stream where reading previously left off.boolean
If specified, OK will be returned when the stream advances beyond this time.int
hashCode()
boolean
If specified, the duration between `Heartbeat` messages on the stream.boolean
The partition to read changes from.boolean
Start reading the stream at the specified timestamp.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
newBuilder
(ReadChangeStreamRequest prototype) protected ReadChangeStreamRequest.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ReadChangeStreamRequest
parseDelimitedFrom
(InputStream input) static ReadChangeStreamRequest
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadChangeStreamRequest
parseFrom
(byte[] data) static ReadChangeStreamRequest
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadChangeStreamRequest
parseFrom
(com.google.protobuf.ByteString data) static ReadChangeStreamRequest
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadChangeStreamRequest
parseFrom
(com.google.protobuf.CodedInputStream input) static ReadChangeStreamRequest
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadChangeStreamRequest
parseFrom
(InputStream input) static ReadChangeStreamRequest
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadChangeStreamRequest
parseFrom
(ByteBuffer data) static ReadChangeStreamRequest
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ReadChangeStreamRequest>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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 Details
-
TABLE_NAME_FIELD_NUMBER
public static final int TABLE_NAME_FIELD_NUMBER- See Also:
-
APP_PROFILE_ID_FIELD_NUMBER
public static final int APP_PROFILE_ID_FIELD_NUMBER- See Also:
-
PARTITION_FIELD_NUMBER
public static final int PARTITION_FIELD_NUMBER- See Also:
-
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER- See Also:
-
CONTINUATION_TOKENS_FIELD_NUMBER
public static final int CONTINUATION_TOKENS_FIELD_NUMBER- See Also:
-
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER- See Also:
-
HEARTBEAT_DURATION_FIELD_NUMBER
public static final int HEARTBEAT_DURATION_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getStartFromCase
- Specified by:
getStartFromCase
in interfaceReadChangeStreamRequestOrBuilder
-
getTableName
Required. The unique name of the table from which to read a change stream. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`. Change streaming must be enabled on the table.
string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getTableName
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The tableName.
-
getTableNameBytes
public com.google.protobuf.ByteString getTableNameBytes()Required. The unique name of the table from which to read a change stream. Values are of the form `projects/<project>/instances/<instance>/tables/<table>`. Change streaming must be enabled on the table.
string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
- Specified by:
getTableNameBytes
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The bytes for tableName.
-
getAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.
string app_profile_id = 2;
- Specified by:
getAppProfileId
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The appProfileId.
-
getAppProfileIdBytes
public com.google.protobuf.ByteString getAppProfileIdBytes()This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.
string app_profile_id = 2;
- Specified by:
getAppProfileIdBytes
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The bytes for appProfileId.
-
hasPartition
public boolean hasPartition()The partition to read changes from.
.google.bigtable.v2.StreamPartition partition = 3;
- Specified by:
hasPartition
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- Whether the partition field is set.
-
getPartition
The partition to read changes from.
.google.bigtable.v2.StreamPartition partition = 3;
- Specified by:
getPartition
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The partition.
-
getPartitionOrBuilder
The partition to read changes from.
.google.bigtable.v2.StreamPartition partition = 3;
- Specified by:
getPartitionOrBuilder
in interfaceReadChangeStreamRequestOrBuilder
-
hasStartTime
public boolean hasStartTime()Start reading the stream at the specified timestamp. This timestamp must be within the change stream retention period, less than or equal to the current time, and after change stream creation, whichever is greater. This value is inclusive and will be truncated to microsecond granularity.
.google.protobuf.Timestamp start_time = 4;
- Specified by:
hasStartTime
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- Whether the startTime field is set.
-
getStartTime
public com.google.protobuf.Timestamp getStartTime()Start reading the stream at the specified timestamp. This timestamp must be within the change stream retention period, less than or equal to the current time, and after change stream creation, whichever is greater. This value is inclusive and will be truncated to microsecond granularity.
.google.protobuf.Timestamp start_time = 4;
- Specified by:
getStartTime
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The startTime.
-
getStartTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()Start reading the stream at the specified timestamp. This timestamp must be within the change stream retention period, less than or equal to the current time, and after change stream creation, whichever is greater. This value is inclusive and will be truncated to microsecond granularity.
.google.protobuf.Timestamp start_time = 4;
- Specified by:
getStartTimeOrBuilder
in interfaceReadChangeStreamRequestOrBuilder
-
hasContinuationTokens
public boolean hasContinuationTokens()Tokens that describe how to resume reading a stream where reading previously left off. If specified, changes will be read starting at the the position. Tokens are delivered on the stream as part of `Heartbeat` and `CloseStream` messages. If a single token is provided, the token’s partition must exactly match the request’s partition. If multiple tokens are provided, as in the case of a partition merge, the union of the token partitions must exactly cover the request’s partition. Otherwise, INVALID_ARGUMENT will be returned.
.google.bigtable.v2.StreamContinuationTokens continuation_tokens = 6;
- Specified by:
hasContinuationTokens
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- Whether the continuationTokens field is set.
-
getContinuationTokens
Tokens that describe how to resume reading a stream where reading previously left off. If specified, changes will be read starting at the the position. Tokens are delivered on the stream as part of `Heartbeat` and `CloseStream` messages. If a single token is provided, the token’s partition must exactly match the request’s partition. If multiple tokens are provided, as in the case of a partition merge, the union of the token partitions must exactly cover the request’s partition. Otherwise, INVALID_ARGUMENT will be returned.
.google.bigtable.v2.StreamContinuationTokens continuation_tokens = 6;
- Specified by:
getContinuationTokens
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The continuationTokens.
-
getContinuationTokensOrBuilder
Tokens that describe how to resume reading a stream where reading previously left off. If specified, changes will be read starting at the the position. Tokens are delivered on the stream as part of `Heartbeat` and `CloseStream` messages. If a single token is provided, the token’s partition must exactly match the request’s partition. If multiple tokens are provided, as in the case of a partition merge, the union of the token partitions must exactly cover the request’s partition. Otherwise, INVALID_ARGUMENT will be returned.
.google.bigtable.v2.StreamContinuationTokens continuation_tokens = 6;
- Specified by:
getContinuationTokensOrBuilder
in interfaceReadChangeStreamRequestOrBuilder
-
hasEndTime
public boolean hasEndTime()If specified, OK will be returned when the stream advances beyond this time. Otherwise, changes will be continuously delivered on the stream. This value is inclusive and will be truncated to microsecond granularity.
.google.protobuf.Timestamp end_time = 5;
- Specified by:
hasEndTime
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- Whether the endTime field is set.
-
getEndTime
public com.google.protobuf.Timestamp getEndTime()If specified, OK will be returned when the stream advances beyond this time. Otherwise, changes will be continuously delivered on the stream. This value is inclusive and will be truncated to microsecond granularity.
.google.protobuf.Timestamp end_time = 5;
- Specified by:
getEndTime
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The endTime.
-
getEndTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()If specified, OK will be returned when the stream advances beyond this time. Otherwise, changes will be continuously delivered on the stream. This value is inclusive and will be truncated to microsecond granularity.
.google.protobuf.Timestamp end_time = 5;
- Specified by:
getEndTimeOrBuilder
in interfaceReadChangeStreamRequestOrBuilder
-
hasHeartbeatDuration
public boolean hasHeartbeatDuration()If specified, the duration between `Heartbeat` messages on the stream. Otherwise, defaults to 5 seconds.
.google.protobuf.Duration heartbeat_duration = 7;
- Specified by:
hasHeartbeatDuration
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- Whether the heartbeatDuration field is set.
-
getHeartbeatDuration
public com.google.protobuf.Duration getHeartbeatDuration()If specified, the duration between `Heartbeat` messages on the stream. Otherwise, defaults to 5 seconds.
.google.protobuf.Duration heartbeat_duration = 7;
- Specified by:
getHeartbeatDuration
in interfaceReadChangeStreamRequestOrBuilder
- Returns:
- The heartbeatDuration.
-
getHeartbeatDurationOrBuilder
public com.google.protobuf.DurationOrBuilder getHeartbeatDurationOrBuilder()If specified, the duration between `Heartbeat` messages on the stream. Otherwise, defaults to 5 seconds.
.google.protobuf.Duration heartbeat_duration = 7;
- Specified by:
getHeartbeatDurationOrBuilder
in interfaceReadChangeStreamRequestOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ReadChangeStreamRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadChangeStreamRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadChangeStreamRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadChangeStreamRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadChangeStreamRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadChangeStreamRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ReadChangeStreamRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ReadChangeStreamRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ReadChangeStreamRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ReadChangeStreamRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ReadChangeStreamRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-