/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/bigtable/v2/bigtable.proto
// Protobuf Java Version: 3.25.2
package com.google.bigtable.v2;
public interface ReadChangeStreamRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.bigtable.v2.ReadChangeStreamRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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) = { ... }
*
*
* @return The tableName.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for tableName.
*/
com.google.protobuf.ByteString getTableNameBytes();
/**
*
*
*
* 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;
*
* @return The appProfileId.
*/
java.lang.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;
*
* @return The bytes for appProfileId.
*/
com.google.protobuf.ByteString getAppProfileIdBytes();
/**
*
*
*
* The partition to read changes from.
*
*
* .google.bigtable.v2.StreamPartition partition = 3;
*
* @return Whether the partition field is set.
*/
boolean hasPartition();
/**
*
*
*
* The partition to read changes from.
*
*
* .google.bigtable.v2.StreamPartition partition = 3;
*
* @return The partition.
*/
com.google.bigtable.v2.StreamPartition getPartition();
/**
*
*
*
* The partition to read changes from.
*
*
* .google.bigtable.v2.StreamPartition partition = 3;
*/
com.google.bigtable.v2.StreamPartitionOrBuilder getPartitionOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the startTime field is set.
*/
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;
*
* @return The startTime.
*/
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;
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the continuationTokens field is set.
*/
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;
*
* @return The continuationTokens.
*/
com.google.bigtable.v2.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;
*/
com.google.bigtable.v2.StreamContinuationTokensOrBuilder getContinuationTokensOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the endTime field is set.
*/
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;
*
* @return The endTime.
*/
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;
*/
com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();
/**
*
*
*
* If specified, the duration between `Heartbeat` messages on the stream.
* Otherwise, defaults to 5 seconds.
*
*
* .google.protobuf.Duration heartbeat_duration = 7;
*
* @return Whether the heartbeatDuration field is set.
*/
boolean hasHeartbeatDuration();
/**
*
*
*
* If specified, the duration between `Heartbeat` messages on the stream.
* Otherwise, defaults to 5 seconds.
*
*
* .google.protobuf.Duration heartbeat_duration = 7;
*
* @return The heartbeatDuration.
*/
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;
*/
com.google.protobuf.DurationOrBuilder getHeartbeatDurationOrBuilder();
com.google.bigtable.v2.ReadChangeStreamRequest.StartFromCase getStartFromCase();
}
