Class ExecuteChangeStreamQuery (6.56.0)

public final class ExecuteChangeStreamQuery extends GeneratedMessageV3 implements ExecuteChangeStreamQueryOrBuilder

Execute a change stream TVF query.

Protobuf type google.spanner.executor.v1.ExecuteChangeStreamQuery

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExecuteChangeStreamQuery

Implements

ExecuteChangeStreamQueryOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CLOUD_DATABASE_ROLE_FIELD_NUMBER

public static final int CLOUD_DATABASE_ROLE_FIELD_NUMBER

Field Value
Type	Description
`int`

DEADLINE_SECONDS_FIELD_NUMBER

public static final int DEADLINE_SECONDS_FIELD_NUMBER

Field Value
Type	Description
`int`

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

HEARTBEAT_MILLISECONDS_FIELD_NUMBER

public static final int HEARTBEAT_MILLISECONDS_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

PARTITION_TOKEN_FIELD_NUMBER

public static final int PARTITION_TOKEN_FIELD_NUMBER

Field Value
Type	Description
`int`

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static ExecuteChangeStreamQuery getDefaultInstance()

Returns
Type	Description
`ExecuteChangeStreamQuery`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static ExecuteChangeStreamQuery.Builder newBuilder()

Returns
Type	Description
`ExecuteChangeStreamQuery.Builder`

newBuilder(ExecuteChangeStreamQuery prototype)

public static ExecuteChangeStreamQuery.Builder newBuilder(ExecuteChangeStreamQuery prototype)

Parameter
Name	Description
`prototype`	`ExecuteChangeStreamQuery`

Returns
Type	Description
`ExecuteChangeStreamQuery.Builder`

parseDelimitedFrom(InputStream input)

public static ExecuteChangeStreamQuery parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static ExecuteChangeStreamQuery parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static ExecuteChangeStreamQuery parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static ExecuteChangeStreamQuery parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static ExecuteChangeStreamQuery parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static ExecuteChangeStreamQuery parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExecuteChangeStreamQuery`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<ExecuteChangeStreamQuery> parser()

Returns
Type	Description
`Parser<ExecuteChangeStreamQuery>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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;

Returns
Type	Description
`String`	The cloudDatabaseRole.

getCloudDatabaseRoleBytes()

public 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
Type	Description
`ByteString`	The bytes for cloudDatabaseRole.

getDeadlineSeconds()

public long getDeadlineSeconds()

Deadline for this change stream query, in seconds.

optional int64 deadline_seconds = 7;

Returns
Type	Description
`long`	The deadlineSeconds.

getDefaultInstanceForType()

public ExecuteChangeStreamQuery getDefaultInstanceForType()

Returns
Type	Description
`ExecuteChangeStreamQuery`

getEndTime()

public 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
Type	Description
`Timestamp`	The endTime.

getEndTimeOrBuilder()

public 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;

Returns
Type	Description
`TimestampOrBuilder`

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;

Returns
Type	Description
`int`	The heartbeatMilliseconds.

getName()

public String getName()

Name for this change stream.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Name for this change stream.

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<ExecuteChangeStreamQuery> getParserForType()

Returns
Type	Description
`Parser<ExecuteChangeStreamQuery>`

Overrides

GeneratedMessageV3.getParserForType()

getPartitionToken()

public String getPartitionToken()

Specifies which change stream partition to query, based on the content of child partitions records.

optional string partition_token = 4;

Returns
Type	Description
`String`	The partitionToken.

getPartitionTokenBytes()

public ByteString getPartitionTokenBytes()

Specifies which change stream partition to query, based on the content of child partitions records.

optional string partition_token = 4;

Returns
Type	Description
`ByteString`	The bytes for partitionToken.

getReadOptions(int index)

public String getReadOptions(int index)

Read options for this change stream query.

repeated string read_options = 5;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The readOptions at the given index.

getReadOptionsBytes(int index)

public ByteString getReadOptionsBytes(int index)

Read options for this change stream query.

repeated string read_options = 5;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the readOptions at the given index.

getReadOptionsCount()

public int getReadOptionsCount()

Read options for this change stream query.

repeated string read_options = 5;

Returns
Type	Description
`int`	The count of readOptions.

getReadOptionsList()

public ProtocolStringList getReadOptionsList()

Read options for this change stream query.

repeated string read_options = 5;

Returns
Type	Description
`ProtocolStringList`	A list containing the readOptions.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getStartTime()

public 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
Type	Description
`Timestamp`	The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Specifies that records with commit_timestamp greater than or equal to start_time should be returned.

.google.protobuf.Timestamp start_time = 2;

Returns
Type	Description
`TimestampOrBuilder`

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;

Returns
Type	Description
`boolean`	Whether the cloudDatabaseRole field is set.

hasDeadlineSeconds()

public boolean hasDeadlineSeconds()

Deadline for this change stream query, in seconds.

optional int64 deadline_seconds = 7;

Returns
Type	Description
`boolean`	Whether the deadlineSeconds field is set.

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;

Returns
Type	Description
`boolean`	Whether the endTime field is set.

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;

Returns
Type	Description
`boolean`	Whether the heartbeatMilliseconds field is set.

hasPartitionToken()

public boolean hasPartitionToken()

Specifies which change stream partition to query, based on the content of child partitions records.

optional string partition_token = 4;

Returns
Type	Description
`boolean`	Whether the partitionToken field is set.

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;

Returns
Type	Description
`boolean`	Whether the startTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ExecuteChangeStreamQuery.Builder newBuilderForType()

Returns
Type	Description
`ExecuteChangeStreamQuery.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecuteChangeStreamQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`ExecuteChangeStreamQuery.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ExecuteChangeStreamQuery.Builder toBuilder()

Returns
Type	Description
`ExecuteChangeStreamQuery.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`