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:

  • 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

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.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 class com.google.protobuf.GeneratedMessageV3

    • getStartFromCase

      public ReadChangeStreamRequest.StartFromCase getStartFromCase()
      Specified by:
      getStartFromCase in interface ReadChangeStreamRequestOrBuilder

    • getTableName

      public 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) = { ... }
      Specified by:
      getTableName in interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder
      Returns:
      The bytes for tableName.

    • getAppProfileId

      public 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;
      Specified by:
      getAppProfileId in interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder
      Returns:
      Whether the partition field is set.

    • getPartition

      public StreamPartition getPartition()
       The partition to read changes from.
      .google.bigtable.v2.StreamPartition partition = 3;
      Specified by:
      getPartition in interface ReadChangeStreamRequestOrBuilder
      Returns:
      The partition.

    • getPartitionOrBuilder

      public StreamPartitionOrBuilder getPartitionOrBuilder()
       The partition to read changes from.
      .google.bigtable.v2.StreamPartition partition = 3;
      Specified by:
      getPartitionOrBuilder in interface ReadChangeStreamRequestOrBuilder

    • 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 interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder

    • 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 interface ReadChangeStreamRequestOrBuilder
      Returns:
      Whether the continuationTokens field is set.

    • getContinuationTokens

      public 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;
      Specified by:
      getContinuationTokens in interface ReadChangeStreamRequestOrBuilder
      Returns:
      The continuationTokens.

    • getContinuationTokensOrBuilder

      public 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;
      Specified by:
      getContinuationTokensOrBuilder in interface ReadChangeStreamRequestOrBuilder

    • 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 interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder

    • 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 interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder
      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 interface ReadChangeStreamRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(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 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

      public static ReadChangeStreamRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReadChangeStreamRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ReadChangeStreamRequest parseDelimitedFrom(InputStream input) throws IOException
      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

      public ReadChangeStreamRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ReadChangeStreamRequest.Builder newBuilder()

    • newBuilder

      public static ReadChangeStreamRequest.Builder newBuilder(ReadChangeStreamRequest prototype)

    • toBuilder

      public ReadChangeStreamRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ReadChangeStreamRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ReadChangeStreamRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ReadChangeStreamRequest> 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.GeneratedMessageV3

    • getDefaultInstanceForType

      public ReadChangeStreamRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder