Interface ExecuteChangeStreamQueryOrBuilder (6.71.0)

public interface ExecuteChangeStreamQueryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCloudDatabaseRole()

public abstract 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 abstract 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 abstract long getDeadlineSeconds()

Deadline for this change stream query, in seconds.

optional int64 deadline_seconds = 7;

Returns
Type Description
long

The deadlineSeconds.

getEndTime()

public abstract 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 abstract 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 abstract 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 abstract String getName()

Name for this change stream.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Name for this change stream.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPartitionToken()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract int getReadOptionsCount()

Read options for this change stream query.

repeated string read_options = 5;

Returns
Type Description
int

The count of readOptions.

getReadOptionsList()

public abstract List<String> getReadOptionsList()

Read options for this change stream query.

repeated string read_options = 5;

Returns
Type Description
List<String>

A list containing the readOptions.

getStartTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.