Package com.google.spanner.executor.v1

Class ExecuteChangeStreamQuery.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>
com.google.spanner.executor.v1.ExecuteChangeStreamQuery.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExecuteChangeStreamQueryOrBuilder, Cloneable
Enclosing class:
ExecuteChangeStreamQuery
public static final class ExecuteChangeStreamQuery.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder> implements ExecuteChangeStreamQueryOrBuilder
 Execute a change stream TVF query.
Protobuf type google.spanner.executor.v1.ExecuteChangeStreamQuery

  • Method Details

    • 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.Builder<ExecuteChangeStreamQuery.Builder>

    • clear

      public ExecuteChangeStreamQuery.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public ExecuteChangeStreamQuery.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • setField

      public ExecuteChangeStreamQuery.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • clearField

      public ExecuteChangeStreamQuery.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • clearOneof

      public ExecuteChangeStreamQuery.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • setRepeatedField

      public ExecuteChangeStreamQuery.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • addRepeatedField

      public ExecuteChangeStreamQuery.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • mergeFrom

      public ExecuteChangeStreamQuery.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExecuteChangeStreamQuery.Builder>

    • mergeFrom

      public ExecuteChangeStreamQuery.Builder mergeFrom(ExecuteChangeStreamQuery other)

    • isInitialized

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

    • mergeFrom

      public ExecuteChangeStreamQuery.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExecuteChangeStreamQuery.Builder>
      Throws:
      IOException

    • 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.

    • setName

      public ExecuteChangeStreamQuery.Builder setName(String value)
       Name for this change stream.
      string name = 1;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public ExecuteChangeStreamQuery.Builder clearName()
       Name for this change stream.
      string name = 1;
      Returns:
      This builder for chaining.

    • setNameBytes

      public ExecuteChangeStreamQuery.Builder setNameBytes(com.google.protobuf.ByteString value)
       Name for this change stream.
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setStartTime

      public ExecuteChangeStreamQuery.Builder setStartTime(com.google.protobuf.Timestamp value)
       Specifies that records with commit_timestamp greater than or equal to
 start_time should be returned.
      .google.protobuf.Timestamp start_time = 2;

    • setStartTime

      public ExecuteChangeStreamQuery.Builder setStartTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Specifies that records with commit_timestamp greater than or equal to
 start_time should be returned.
      .google.protobuf.Timestamp start_time = 2;

    • mergeStartTime

      public ExecuteChangeStreamQuery.Builder mergeStartTime(com.google.protobuf.Timestamp value)
       Specifies that records with commit_timestamp greater than or equal to
 start_time should be returned.
      .google.protobuf.Timestamp start_time = 2;

    • clearStartTime

      public ExecuteChangeStreamQuery.Builder clearStartTime()
       Specifies that records with commit_timestamp greater than or equal to
 start_time should be returned.
      .google.protobuf.Timestamp start_time = 2;

    • getStartTimeBuilder

      public com.google.protobuf.Timestamp.Builder getStartTimeBuilder()
       Specifies that records with commit_timestamp greater than or equal to
 start_time should be returned.
      .google.protobuf.Timestamp start_time = 2;

    • 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.

    • setEndTime

      public ExecuteChangeStreamQuery.Builder setEndTime(com.google.protobuf.Timestamp value)
       Specifies that records with commit_timestamp less than or equal to
 end_time should be returned.
      optional .google.protobuf.Timestamp end_time = 3;

    • setEndTime

      public ExecuteChangeStreamQuery.Builder setEndTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Specifies that records with commit_timestamp less than or equal to
 end_time should be returned.
      optional .google.protobuf.Timestamp end_time = 3;

    • mergeEndTime

      public ExecuteChangeStreamQuery.Builder mergeEndTime(com.google.protobuf.Timestamp value)
       Specifies that records with commit_timestamp less than or equal to
 end_time should be returned.
      optional .google.protobuf.Timestamp end_time = 3;

    • clearEndTime

      public ExecuteChangeStreamQuery.Builder clearEndTime()
       Specifies that records with commit_timestamp less than or equal to
 end_time should be returned.
      optional .google.protobuf.Timestamp end_time = 3;

    • getEndTimeBuilder

      public com.google.protobuf.Timestamp.Builder getEndTimeBuilder()
       Specifies that records with commit_timestamp less than or equal to
 end_time should be returned.
      optional .google.protobuf.Timestamp end_time = 3;

    • 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.

    • setPartitionToken

      public ExecuteChangeStreamQuery.Builder setPartitionToken(String value)
       Specifies which change stream partition to query, based on the content of
 child partitions records.
      optional string partition_token = 4;
      Parameters:
      value - The partitionToken to set.
      Returns:
      This builder for chaining.

    • clearPartitionToken

      public ExecuteChangeStreamQuery.Builder clearPartitionToken()
       Specifies which change stream partition to query, based on the content of
 child partitions records.
      optional string partition_token = 4;
      Returns:
      This builder for chaining.

    • setPartitionTokenBytes

      public ExecuteChangeStreamQuery.Builder setPartitionTokenBytes(com.google.protobuf.ByteString value)
       Specifies which change stream partition to query, based on the content of
 child partitions records.
      optional string partition_token = 4;
      Parameters:
      value - The bytes for partitionToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setReadOptions

      public ExecuteChangeStreamQuery.Builder setReadOptions(int index, String value)
       Read options for this change stream query.
      repeated string read_options = 5;
      Parameters:
      index - The index to set the value at.
      value - The readOptions to set.
      Returns:
      This builder for chaining.

    • addReadOptions

      public ExecuteChangeStreamQuery.Builder addReadOptions(String value)
       Read options for this change stream query.
      repeated string read_options = 5;
      Parameters:
      value - The readOptions to add.
      Returns:
      This builder for chaining.

    • addAllReadOptions

      public ExecuteChangeStreamQuery.Builder addAllReadOptions(Iterable<String> values)
       Read options for this change stream query.
      repeated string read_options = 5;
      Parameters:
      values - The readOptions to add.
      Returns:
      This builder for chaining.

    • clearReadOptions

      public ExecuteChangeStreamQuery.Builder clearReadOptions()
       Read options for this change stream query.
      repeated string read_options = 5;
      Returns:
      This builder for chaining.

    • addReadOptionsBytes

      public ExecuteChangeStreamQuery.Builder addReadOptionsBytes(com.google.protobuf.ByteString value)
       Read options for this change stream query.
      repeated string read_options = 5;
      Parameters:
      value - The bytes of the readOptions to add.
      Returns:
      This builder for chaining.

    • 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.

    • setHeartbeatMilliseconds

      public ExecuteChangeStreamQuery.Builder setHeartbeatMilliseconds(int value)
       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;
      Parameters:
      value - The heartbeatMilliseconds to set.
      Returns:
      This builder for chaining.

    • clearHeartbeatMilliseconds

      public ExecuteChangeStreamQuery.Builder clearHeartbeatMilliseconds()
       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:
      This builder for chaining.

    • 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.

    • setDeadlineSeconds

      public ExecuteChangeStreamQuery.Builder setDeadlineSeconds(long value)
       Deadline for this change stream query, in seconds.
      optional int64 deadline_seconds = 7;
      Parameters:
      value - The deadlineSeconds to set.
      Returns:
      This builder for chaining.

    • clearDeadlineSeconds

      public ExecuteChangeStreamQuery.Builder clearDeadlineSeconds()
       Deadline for this change stream query, in seconds.
      optional int64 deadline_seconds = 7;
      Returns:
      This builder for chaining.

    • 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.

    • setCloudDatabaseRole

      public ExecuteChangeStreamQuery.Builder setCloudDatabaseRole(String value)
       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;
      Parameters:
      value - The cloudDatabaseRole to set.
      Returns:
      This builder for chaining.

    • clearCloudDatabaseRole

      public ExecuteChangeStreamQuery.Builder clearCloudDatabaseRole()
       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:
      This builder for chaining.

    • setCloudDatabaseRoleBytes

      public ExecuteChangeStreamQuery.Builder setCloudDatabaseRoleBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for cloudDatabaseRole to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final ExecuteChangeStreamQuery.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>

    • mergeUnknownFields

      public final ExecuteChangeStreamQuery.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder>