Package com.google.bigtable.v2
Interface ReadChangeStreamRequestOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ReadChangeStreamRequest
,ReadChangeStreamRequest.Builder
public interface ReadChangeStreamRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionThis 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.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.The partition to read changes from.The partition to read changes from.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.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.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
-
getTableName
String 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) = { ... }
- Returns:
- The tableName.
-
getTableNameBytes
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) = { ... }
- Returns:
- The bytes for tableName.
-
getAppProfileId
String 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;
- Returns:
- The appProfileId.
-
getAppProfileIdBytes
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;
- Returns:
- The bytes for appProfileId.
-
hasPartition
boolean hasPartition()The partition to read changes from.
.google.bigtable.v2.StreamPartition partition = 3;
- Returns:
- Whether the partition field is set.
-
getPartition
StreamPartition getPartition()The partition to read changes from.
.google.bigtable.v2.StreamPartition partition = 3;
- Returns:
- The partition.
-
getPartitionOrBuilder
StreamPartitionOrBuilder getPartitionOrBuilder()The partition to read changes from.
.google.bigtable.v2.StreamPartition partition = 3;
-
hasStartTime
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;
- Returns:
- Whether the startTime field is set.
-
getStartTime
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;
- Returns:
- The startTime.
-
getStartTimeOrBuilder
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;
-
hasContinuationTokens
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;
- Returns:
- Whether the continuationTokens field is set.
-
getContinuationTokens
StreamContinuationTokens 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;
- Returns:
- The continuationTokens.
-
getContinuationTokensOrBuilder
StreamContinuationTokensOrBuilder 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;
-
hasEndTime
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;
- Returns:
- Whether the endTime field is set.
-
getEndTime
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;
- Returns:
- The endTime.
-
getEndTimeOrBuilder
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;
-
hasHeartbeatDuration
boolean hasHeartbeatDuration()If specified, the duration between `Heartbeat` messages on the stream. Otherwise, defaults to 5 seconds.
.google.protobuf.Duration heartbeat_duration = 7;
- Returns:
- Whether the heartbeatDuration field is set.
-
getHeartbeatDuration
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;
- Returns:
- The heartbeatDuration.
-
getHeartbeatDurationOrBuilder
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;
-
getStartFromCase
ReadChangeStreamRequest.StartFromCase getStartFromCase()
-