public final class ExecuteChangeStreamQuery extends GeneratedMessageV3 implements ExecuteChangeStreamQueryOrBuilder
Execute a change stream TVF query.
Protobuf type google.spanner.executor.v1.ExecuteChangeStreamQuery
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ExecuteChangeStreamQuery.Builder newBuilder()
newBuilder(ExecuteChangeStreamQuery prototype)
public static ExecuteChangeStreamQuery.Builder newBuilder(ExecuteChangeStreamQuery prototype)
public static ExecuteChangeStreamQuery parseDelimitedFrom(InputStream input)
public static ExecuteChangeStreamQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ExecuteChangeStreamQuery parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExecuteChangeStreamQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ExecuteChangeStreamQuery parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecuteChangeStreamQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecuteChangeStreamQuery parseFrom(CodedInputStream input)
public static ExecuteChangeStreamQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExecuteChangeStreamQuery parseFrom(InputStream input)
public static ExecuteChangeStreamQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ExecuteChangeStreamQuery parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExecuteChangeStreamQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ExecuteChangeStreamQuery> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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()
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;
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()
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()
Overrides
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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;
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ExecuteChangeStreamQuery.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExecuteChangeStreamQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ExecuteChangeStreamQuery.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
