Class ExecuteChangeStreamQuery

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.executor.v1.ExecuteChangeStreamQuery
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExecuteChangeStreamQueryOrBuilder, Serializable

public final class ExecuteChangeStreamQuery extends com.google.protobuf.GeneratedMessageV3 implements ExecuteChangeStreamQueryOrBuilder
 Execute a change stream TVF query.
 
Protobuf type google.spanner.executor.v1.ExecuteChangeStreamQuery
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Execute a change stream TVF query.

    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

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static 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 Type
    Method
    Description
    boolean
     
    Database role to assume while performing this action.
    com.google.protobuf.ByteString
    Database role to assume while performing this action.
    long
    Deadline for this change stream query, in seconds.
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Timestamp
    Specifies that records with commit_timestamp less than or equal to end_time should be returned.
    com.google.protobuf.TimestampOrBuilder
    Specifies that records with commit_timestamp less than or equal to end_time should be returned.
    int
    Determines how frequently a heartbeat ChangeRecord will be returned in case there are no transactions committed in this partition, in milliseconds.
    Name for this change stream.
    com.google.protobuf.ByteString
    Name for this change stream.
    com.google.protobuf.Parser<ExecuteChangeStreamQuery>
     
    Specifies which change stream partition to query, based on the content of child partitions records.
    com.google.protobuf.ByteString
    Specifies which change stream partition to query, based on the content of child partitions records.
    getReadOptions(int index)
    Read options for this change stream query.
    com.google.protobuf.ByteString
    Read options for this change stream query.
    int
    Read options for this change stream query.
    com.google.protobuf.ProtocolStringList
    Read options for this change stream query.
    int
     
    com.google.protobuf.Timestamp
    Specifies that records with commit_timestamp greater than or equal to start_time should be returned.
    com.google.protobuf.TimestampOrBuilder
    Specifies that records with commit_timestamp greater than or equal to start_time should be returned.
    boolean
    Database role to assume while performing this action.
    boolean
    Deadline for this change stream query, in seconds.
    boolean
    Specifies that records with commit_timestamp less than or equal to end_time should be returned.
    int
     
    boolean
    Determines how frequently a heartbeat ChangeRecord will be returned in case there are no transactions committed in this partition, in milliseconds.
    boolean
    Specifies which change stream partition to query, based on the content of child partitions records.
    boolean
    Specifies that records with commit_timestamp greater than or equal to start_time should be returned.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ExecuteChangeStreamQuery>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:
    • END_TIME_FIELD_NUMBER

      public static final int END_TIME_FIELD_NUMBER
      See Also:
    • PARTITION_TOKEN_FIELD_NUMBER

      public static final int PARTITION_TOKEN_FIELD_NUMBER
      See Also:
    • READ_OPTIONS_FIELD_NUMBER

      public static final int READ_OPTIONS_FIELD_NUMBER
      See Also:
    • HEARTBEAT_MILLISECONDS_FIELD_NUMBER

      public static final int HEARTBEAT_MILLISECONDS_FIELD_NUMBER
      See Also:
    • DEADLINE_SECONDS_FIELD_NUMBER

      public static final int DEADLINE_SECONDS_FIELD_NUMBER
      See Also:
    • CLOUD_DATABASE_ROLE_FIELD_NUMBER

      public static final int CLOUD_DATABASE_ROLE_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
    • getName

      public String getName()
       Name for this change stream.
       
      string name = 1;
      Specified by:
      getName in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name for this change stream.
       
      string name = 1;
      Specified by:
      getNameBytes in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The bytes for name.
    • hasStartTime

      public boolean hasStartTime()
       Specifies that records with commit_timestamp greater than or equal to
       start_time should be returned.
       
      .google.protobuf.Timestamp start_time = 2;
      Specified by:
      hasStartTime in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      Whether the startTime field is set.
    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       Specifies that records with commit_timestamp greater than or equal to
       start_time should be returned.
       
      .google.protobuf.Timestamp start_time = 2;
      Specified by:
      getStartTime in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The startTime.
    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Specifies that records with commit_timestamp greater than or equal to
       start_time should be returned.
       
      .google.protobuf.Timestamp start_time = 2;
      Specified by:
      getStartTimeOrBuilder in interface ExecuteChangeStreamQueryOrBuilder
    • hasEndTime

      public boolean hasEndTime()
       Specifies that records with commit_timestamp less than or equal to
       end_time should be returned.
       
      optional .google.protobuf.Timestamp end_time = 3;
      Specified by:
      hasEndTime in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      Whether the endTime field is set.
    • getEndTime

      public com.google.protobuf.Timestamp getEndTime()
       Specifies that records with commit_timestamp less than or equal to
       end_time should be returned.
       
      optional .google.protobuf.Timestamp end_time = 3;
      Specified by:
      getEndTime in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The endTime.
    • getEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       Specifies that records with commit_timestamp less than or equal to
       end_time should be returned.
       
      optional .google.protobuf.Timestamp end_time = 3;
      Specified by:
      getEndTimeOrBuilder in interface ExecuteChangeStreamQueryOrBuilder
    • hasPartitionToken

      public boolean hasPartitionToken()
       Specifies which change stream partition to query, based on the content of
       child partitions records.
       
      optional string partition_token = 4;
      Specified by:
      hasPartitionToken in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      Whether the partitionToken field is set.
    • getPartitionToken

      public String getPartitionToken()
       Specifies which change stream partition to query, based on the content of
       child partitions records.
       
      optional string partition_token = 4;
      Specified by:
      getPartitionToken in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The partitionToken.
    • getPartitionTokenBytes

      public com.google.protobuf.ByteString getPartitionTokenBytes()
       Specifies which change stream partition to query, based on the content of
       child partitions records.
       
      optional string partition_token = 4;
      Specified by:
      getPartitionTokenBytes in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The bytes for partitionToken.
    • getReadOptionsList

      public com.google.protobuf.ProtocolStringList getReadOptionsList()
       Read options for this change stream query.
       
      repeated string read_options = 5;
      Specified by:
      getReadOptionsList in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      A list containing the readOptions.
    • getReadOptionsCount

      public int getReadOptionsCount()
       Read options for this change stream query.
       
      repeated string read_options = 5;
      Specified by:
      getReadOptionsCount in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The count of readOptions.
    • getReadOptions

      public String getReadOptions(int index)
       Read options for this change stream query.
       
      repeated string read_options = 5;
      Specified by:
      getReadOptions in interface ExecuteChangeStreamQueryOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The readOptions at the given index.
    • getReadOptionsBytes

      public com.google.protobuf.ByteString getReadOptionsBytes(int index)
       Read options for this change stream query.
       
      repeated string read_options = 5;
      Specified by:
      getReadOptionsBytes in interface ExecuteChangeStreamQueryOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the readOptions at the given index.
    • hasHeartbeatMilliseconds

      public boolean hasHeartbeatMilliseconds()
       Determines how frequently a heartbeat ChangeRecord will be returned in case
       there are no transactions committed in this partition, in milliseconds.
       
      optional int32 heartbeat_milliseconds = 6;
      Specified by:
      hasHeartbeatMilliseconds in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      Whether the heartbeatMilliseconds field is set.
    • getHeartbeatMilliseconds

      public int getHeartbeatMilliseconds()
       Determines how frequently a heartbeat ChangeRecord will be returned in case
       there are no transactions committed in this partition, in milliseconds.
       
      optional int32 heartbeat_milliseconds = 6;
      Specified by:
      getHeartbeatMilliseconds in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The heartbeatMilliseconds.
    • hasDeadlineSeconds

      public boolean hasDeadlineSeconds()
       Deadline for this change stream query, in seconds.
       
      optional int64 deadline_seconds = 7;
      Specified by:
      hasDeadlineSeconds in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      Whether the deadlineSeconds field is set.
    • getDeadlineSeconds

      public long getDeadlineSeconds()
       Deadline for this change stream query, in seconds.
       
      optional int64 deadline_seconds = 7;
      Specified by:
      getDeadlineSeconds in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The deadlineSeconds.
    • hasCloudDatabaseRole

      public boolean hasCloudDatabaseRole()
       Database role to assume while performing this action. This should only be
       set for cloud requests. Setting the database role will enforce additional
       role-based access checks on this action.
       
      optional string cloud_database_role = 8;
      Specified by:
      hasCloudDatabaseRole in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      Whether the cloudDatabaseRole field is set.
    • getCloudDatabaseRole

      public String getCloudDatabaseRole()
       Database role to assume while performing this action. This should only be
       set for cloud requests. Setting the database role will enforce additional
       role-based access checks on this action.
       
      optional string cloud_database_role = 8;
      Specified by:
      getCloudDatabaseRole in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The cloudDatabaseRole.
    • getCloudDatabaseRoleBytes

      public com.google.protobuf.ByteString getCloudDatabaseRoleBytes()
       Database role to assume while performing this action. This should only be
       set for cloud requests. Setting the database role will enforce additional
       role-based access checks on this action.
       
      optional string cloud_database_role = 8;
      Specified by:
      getCloudDatabaseRoleBytes in interface ExecuteChangeStreamQueryOrBuilder
      Returns:
      The bytes for cloudDatabaseRole.
    • 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 ExecuteChangeStreamQuery parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExecuteChangeStreamQuery parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExecuteChangeStreamQuery parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExecuteChangeStreamQuery parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExecuteChangeStreamQuery parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExecuteChangeStreamQuery parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ExecuteChangeStreamQuery parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static ExecuteChangeStreamQuery parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

      public static ExecuteChangeStreamQuery parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ExecuteChangeStreamQuery parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

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

      public static ExecuteChangeStreamQuery.Builder newBuilder()
    • newBuilder

      public static ExecuteChangeStreamQuery.Builder newBuilder(ExecuteChangeStreamQuery prototype)
    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

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

      public static ExecuteChangeStreamQuery getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ExecuteChangeStreamQuery> parser()
    • getParserForType

      public com.google.protobuf.Parser<ExecuteChangeStreamQuery> 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 ExecuteChangeStreamQuery getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder