Package com.google.spanner.executor.v1
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 ClassesModifier and TypeClassDescriptionstatic final classExecute 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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanDatabase role to assume while performing this action.com.google.protobuf.ByteStringDatabase role to assume while performing this action.longDeadline for this change stream query, in seconds.static ExecuteChangeStreamQuerystatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.TimestampSpecifies that records with commit_timestamp less than or equal to end_time should be returned.com.google.protobuf.TimestampOrBuilderSpecifies that records with commit_timestamp less than or equal to end_time should be returned.intDetermines how frequently a heartbeat ChangeRecord will be returned in case there are no transactions committed in this partition, in milliseconds.getName()Name for this change stream.com.google.protobuf.ByteStringName 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.ByteStringSpecifies 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.ByteStringgetReadOptionsBytes(int index) Read options for this change stream query.intRead options for this change stream query.com.google.protobuf.ProtocolStringListRead options for this change stream query.intcom.google.protobuf.TimestampSpecifies that records with commit_timestamp greater than or equal to start_time should be returned.com.google.protobuf.TimestampOrBuilderSpecifies that records with commit_timestamp greater than or equal to start_time should be returned.booleanDatabase role to assume while performing this action.booleanDeadline for this change stream query, in seconds.booleanSpecifies that records with commit_timestamp less than or equal to end_time should be returned.inthashCode()booleanDetermines how frequently a heartbeat ChangeRecord will be returned in case there are no transactions committed in this partition, in milliseconds.booleanSpecifies which change stream partition to query, based on the content of child partitions records.booleanSpecifies that records with commit_timestamp greater than or equal to start_time should be returned.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilder(ExecuteChangeStreamQuery prototype) protected ExecuteChangeStreamQuery.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ExecuteChangeStreamQueryparseDelimitedFrom(InputStream input) static ExecuteChangeStreamQueryparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExecuteChangeStreamQueryparseFrom(byte[] data) static ExecuteChangeStreamQueryparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExecuteChangeStreamQueryparseFrom(com.google.protobuf.ByteString data) static ExecuteChangeStreamQueryparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExecuteChangeStreamQueryparseFrom(com.google.protobuf.CodedInputStream input) static ExecuteChangeStreamQueryparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExecuteChangeStreamQueryparseFrom(InputStream input) static ExecuteChangeStreamQueryparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ExecuteChangeStreamQueryparseFrom(ByteBuffer data) static ExecuteChangeStreamQueryparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ExecuteChangeStreamQuery>parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods 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
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getName
Name for this change stream.
string name = 1;- Specified by:
getNamein interfaceExecuteChangeStreamQueryOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Name for this change stream.
string name = 1;- Specified by:
getNameBytesin interfaceExecuteChangeStreamQueryOrBuilder- 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:
hasStartTimein interfaceExecuteChangeStreamQueryOrBuilder- 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:
getStartTimein interfaceExecuteChangeStreamQueryOrBuilder- 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:
getStartTimeOrBuilderin interfaceExecuteChangeStreamQueryOrBuilder
-
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:
hasEndTimein interfaceExecuteChangeStreamQueryOrBuilder- 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:
getEndTimein interfaceExecuteChangeStreamQueryOrBuilder- 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:
getEndTimeOrBuilderin interfaceExecuteChangeStreamQueryOrBuilder
-
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:
hasPartitionTokenin interfaceExecuteChangeStreamQueryOrBuilder- Returns:
- Whether the partitionToken field is set.
-
getPartitionToken
Specifies which change stream partition to query, based on the content of child partitions records.
optional string partition_token = 4;- Specified by:
getPartitionTokenin interfaceExecuteChangeStreamQueryOrBuilder- 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:
getPartitionTokenBytesin interfaceExecuteChangeStreamQueryOrBuilder- 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:
getReadOptionsListin interfaceExecuteChangeStreamQueryOrBuilder- Returns:
- A list containing the readOptions.
-
getReadOptionsCount
public int getReadOptionsCount()Read options for this change stream query.
repeated string read_options = 5;- Specified by:
getReadOptionsCountin interfaceExecuteChangeStreamQueryOrBuilder- Returns:
- The count of readOptions.
-
getReadOptions
Read options for this change stream query.
repeated string read_options = 5;- Specified by:
getReadOptionsin interfaceExecuteChangeStreamQueryOrBuilder- 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:
getReadOptionsBytesin interfaceExecuteChangeStreamQueryOrBuilder- 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:
hasHeartbeatMillisecondsin interfaceExecuteChangeStreamQueryOrBuilder- 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:
getHeartbeatMillisecondsin interfaceExecuteChangeStreamQueryOrBuilder- Returns:
- The heartbeatMilliseconds.
-
hasDeadlineSeconds
public boolean hasDeadlineSeconds()Deadline for this change stream query, in seconds.
optional int64 deadline_seconds = 7;- Specified by:
hasDeadlineSecondsin interfaceExecuteChangeStreamQueryOrBuilder- 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:
getDeadlineSecondsin interfaceExecuteChangeStreamQueryOrBuilder- 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:
hasCloudDatabaseRolein interfaceExecuteChangeStreamQueryOrBuilder- Returns:
- Whether the cloudDatabaseRole field is set.
-
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:
getCloudDatabaseRolein interfaceExecuteChangeStreamQueryOrBuilder- 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:
getCloudDatabaseRoleBytesin interfaceExecuteChangeStreamQueryOrBuilder- Returns:
- The bytes for cloudDatabaseRole.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static ExecuteChangeStreamQuery parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ExecuteChangeStreamQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-