Package com.google.spanner.executor.v1

Interface ExecuteChangeStreamQueryOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExecuteChangeStreamQuery, ExecuteChangeStreamQuery.Builder
public interface ExecuteChangeStreamQueryOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCloudDatabaseRole()
    Database role to assume while performing this action.
    com.google.protobuf.ByteString
    getCloudDatabaseRoleBytes()
    Database role to assume while performing this action.
    long
    getDeadlineSeconds()
    Deadline for this change stream query, in seconds.
    com.google.protobuf.Timestamp
    getEndTime()
    Specifies that records with commit_timestamp less than or equal to end_time should be returned.
    com.google.protobuf.TimestampOrBuilder
    getEndTimeOrBuilder()
    Specifies that records with commit_timestamp less than or equal to end_time should be returned.
    int
    getHeartbeatMilliseconds()
    Determines how frequently a heartbeat ChangeRecord will be returned in case there are no transactions committed in this partition, in milliseconds.
    String
    getName()
    Name for this change stream.
    com.google.protobuf.ByteString
    getNameBytes()
    Name for this change stream.
    String
    getPartitionToken()
    Specifies which change stream partition to query, based on the content of child partitions records.
    com.google.protobuf.ByteString
    getPartitionTokenBytes()
    Specifies which change stream partition to query, based on the content of child partitions records.
    String
    getReadOptions(int index)
    Read options for this change stream query.
    com.google.protobuf.ByteString
    getReadOptionsBytes(int index)
    Read options for this change stream query.
    int
    getReadOptionsCount()
    Read options for this change stream query.
    List<String>
    getReadOptionsList()
    Read options for this change stream query.
    com.google.protobuf.Timestamp
    getStartTime()
    Specifies that records with commit_timestamp greater than or equal to start_time should be returned.
    com.google.protobuf.TimestampOrBuilder
    getStartTimeOrBuilder()
    Specifies that records with commit_timestamp greater than or equal to start_time should be returned.
    boolean
    hasCloudDatabaseRole()
    Database role to assume while performing this action.
    boolean
    hasDeadlineSeconds()
    Deadline for this change stream query, in seconds.
    boolean
    hasEndTime()
    Specifies that records with commit_timestamp less than or equal to end_time should be returned.
    boolean
    hasHeartbeatMilliseconds()
    Determines how frequently a heartbeat ChangeRecord will be returned in case there are no transactions committed in this partition, in milliseconds.
    boolean
    hasPartitionToken()
    Specifies which change stream partition to query, based on the content of child partitions records.
    boolean
    hasStartTime()
    Specifies that records with commit_timestamp greater than or equal to start_time should be returned.

    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

    • getName

      String getName()
       Name for this change stream.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name for this change stream.
      string name = 1;
      Returns:
      The bytes for name.

    • hasStartTime

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

    • getStartTime

      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;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      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;

    • hasEndTime

      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;
      Returns:
      Whether the endTime field is set.

    • getEndTime

      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;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      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;

    • hasPartitionToken

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

    • getPartitionToken

      String getPartitionToken()
       Specifies which change stream partition to query, based on the content of
 child partitions records.
      optional string partition_token = 4;
      Returns:
      The partitionToken.

    • getPartitionTokenBytes

      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;
      Returns:
      The bytes for partitionToken.

    • getReadOptionsList

      List<String> getReadOptionsList()
       Read options for this change stream query.
      repeated string read_options = 5;
      Returns:
      A list containing the readOptions.

    • getReadOptionsCount

      int getReadOptionsCount()
       Read options for this change stream query.
      repeated string read_options = 5;
      Returns:
      The count of readOptions.

    • getReadOptions

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

    • getReadOptionsBytes

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

    • hasHeartbeatMilliseconds

      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;
      Returns:
      Whether the heartbeatMilliseconds field is set.

    • getHeartbeatMilliseconds

      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;
      Returns:
      The heartbeatMilliseconds.

    • hasDeadlineSeconds

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

    • getDeadlineSeconds

      long getDeadlineSeconds()
       Deadline for this change stream query, in seconds.
      optional int64 deadline_seconds = 7;
      Returns:
      The deadlineSeconds.

    • hasCloudDatabaseRole

      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;
      Returns:
      Whether the cloudDatabaseRole field is set.

    • getCloudDatabaseRole

      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;
      Returns:
      The cloudDatabaseRole.

    • getCloudDatabaseRoleBytes

      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;
      Returns:
      The bytes for cloudDatabaseRole.