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

Static Fields

CLOUD_DATABASE_ROLE_FIELD_NUMBER

public static final int CLOUD_DATABASE_ROLE_FIELD_NUMBER
Field Value
TypeDescription
int

DEADLINE_SECONDS_FIELD_NUMBER

public static final int DEADLINE_SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

HEARTBEAT_MILLISECONDS_FIELD_NUMBER

public static final int HEARTBEAT_MILLISECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITION_TOKEN_FIELD_NUMBER

public static final int PARTITION_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExecuteChangeStreamQuery getDefaultInstance()
Returns
TypeDescription
ExecuteChangeStreamQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExecuteChangeStreamQuery.Builder newBuilder()
Returns
TypeDescription
ExecuteChangeStreamQuery.Builder

newBuilder(ExecuteChangeStreamQuery prototype)

public static ExecuteChangeStreamQuery.Builder newBuilder(ExecuteChangeStreamQuery prototype)
Parameter
NameDescription
prototypeExecuteChangeStreamQuery
Returns
TypeDescription
ExecuteChangeStreamQuery.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteChangeStreamQuery parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExecuteChangeStreamQuery parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteChangeStreamQuery parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteChangeStreamQuery parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExecuteChangeStreamQuery parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExecuteChangeStreamQuery parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteChangeStreamQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteChangeStreamQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExecuteChangeStreamQuery> parser()
Returns
TypeDescription
Parser<ExecuteChangeStreamQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
ByteString

The bytes for cloudDatabaseRole.

getDeadlineSeconds()

public long getDeadlineSeconds()

Deadline for this change stream query, in seconds.

optional int64 deadline_seconds = 7;

Returns
TypeDescription
long

The deadlineSeconds.

getDefaultInstanceForType()

public ExecuteChangeStreamQuery getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The heartbeatMilliseconds.

getName()

public String getName()

Name for this change stream.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name for this change stream.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ExecuteChangeStreamQuery> getParserForType()
Returns
TypeDescription
Parser<ExecuteChangeStreamQuery>
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
int

The count of readOptions.

getReadOptionsList()

public ProtocolStringList getReadOptionsList()

Read options for this change stream query.

repeated string read_options = 5;

Returns
TypeDescription
ProtocolStringList

A list containing the readOptions.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExecuteChangeStreamQuery.Builder newBuilderForType()
Returns
TypeDescription
ExecuteChangeStreamQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecuteChangeStreamQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExecuteChangeStreamQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExecuteChangeStreamQuery.Builder toBuilder()
Returns
TypeDescription
ExecuteChangeStreamQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException