Interface ExecuteChangeStreamQueryOrBuilder (6.89.0)

publicinterfaceExecuteChangeStreamQueryOrBuilderextendsMessageOrBuilder

Methods

getCloudDatabaseRole()

publicabstractStringgetCloudDatabaseRole()

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()

publicabstractByteStringgetCloudDatabaseRoleBytes()

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()

publicabstractlonggetDeadlineSeconds()

Deadline for this change stream query, in seconds.

optional int64 deadline_seconds = 7;

Returns
TypeDescription
long

The deadlineSeconds.

getEndTime()

publicabstractTimestampgetEndTime()

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()

publicabstractTimestampOrBuildergetEndTimeOrBuilder()

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()

publicabstractintgetHeartbeatMilliseconds()

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()

publicabstractStringgetName()

Name for this change stream.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

publicabstractByteStringgetNameBytes()

Name for this change stream.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getPartitionToken()

publicabstractStringgetPartitionToken()

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()

publicabstractByteStringgetPartitionTokenBytes()

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)

publicabstractStringgetReadOptions(intindex)

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)

publicabstractByteStringgetReadOptionsBytes(intindex)

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()

publicabstractintgetReadOptionsCount()

Read options for this change stream query.

repeated string read_options = 5;

Returns
TypeDescription
int

The count of readOptions.

getReadOptionsList()

publicabstractList<String>getReadOptionsList()

Read options for this change stream query.

repeated string read_options = 5;

Returns
TypeDescription
List<String>

A list containing the readOptions.

getStartTime()

publicabstractTimestampgetStartTime()

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()

publicabstractTimestampOrBuildergetStartTimeOrBuilder()

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()

publicabstractbooleanhasCloudDatabaseRole()

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()

publicabstractbooleanhasDeadlineSeconds()

Deadline for this change stream query, in seconds.

optional int64 deadline_seconds = 7;

Returns
TypeDescription
boolean

Whether the deadlineSeconds field is set.

hasEndTime()

publicabstractbooleanhasEndTime()

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()

publicabstractbooleanhasHeartbeatMilliseconds()

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()

publicabstractbooleanhasPartitionToken()

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()

publicabstractbooleanhasStartTime()

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.