public static final class ExecuteChangeStreamQuery.Builder extends GeneratedMessageV3.Builder<ExecuteChangeStreamQuery.Builder> implements ExecuteChangeStreamQueryOrBuilder
Execute a change stream TVF query.
Protobuf type google.spanner.executor.v1.ExecuteChangeStreamQuery
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecuteChangeStreamQuery.BuilderImplements
ExecuteChangeStreamQueryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllReadOptions(Iterable<String> values)
public ExecuteChangeStreamQuery.Builder addAllReadOptions(Iterable<String> values)
Read options for this change stream query.
repeated string read_options = 5;
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The readOptions to add. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
addReadOptions(String value)
public ExecuteChangeStreamQuery.Builder addReadOptions(String value)
Read options for this change stream query.
repeated string read_options = 5;
Parameter | |
---|---|
Name | Description |
value |
String The readOptions to add. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
addReadOptionsBytes(ByteString value)
public ExecuteChangeStreamQuery.Builder addReadOptionsBytes(ByteString value)
Read options for this change stream query.
repeated string read_options = 5;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the readOptions to add. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecuteChangeStreamQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
build()
public ExecuteChangeStreamQuery build()
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery |
buildPartial()
public ExecuteChangeStreamQuery buildPartial()
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery |
clear()
public ExecuteChangeStreamQuery.Builder clear()
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
clearCloudDatabaseRole()
public ExecuteChangeStreamQuery.Builder clearCloudDatabaseRole()
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 |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
clearDeadlineSeconds()
public ExecuteChangeStreamQuery.Builder clearDeadlineSeconds()
Deadline for this change stream query, in seconds.
optional int64 deadline_seconds = 7;
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
clearEndTime()
public ExecuteChangeStreamQuery.Builder clearEndTime()
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 |
ExecuteChangeStreamQuery.Builder |
clearField(Descriptors.FieldDescriptor field)
public ExecuteChangeStreamQuery.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
clearHeartbeatMilliseconds()
public ExecuteChangeStreamQuery.Builder clearHeartbeatMilliseconds()
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 |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
clearName()
public ExecuteChangeStreamQuery.Builder clearName()
Name for this change stream.
string name = 1;
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecuteChangeStreamQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
clearPartitionToken()
public ExecuteChangeStreamQuery.Builder clearPartitionToken()
Specifies which change stream partition to query, based on the content of child partitions records.
optional string partition_token = 4;
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
clearReadOptions()
public ExecuteChangeStreamQuery.Builder clearReadOptions()
Read options for this change stream query.
repeated string read_options = 5;
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
clearStartTime()
public ExecuteChangeStreamQuery.Builder clearStartTime()
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 |
ExecuteChangeStreamQuery.Builder |
clone()
public ExecuteChangeStreamQuery.Builder clone()
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
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()
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()
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 |
Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
int |
The heartbeatMilliseconds. |
getName()
public String 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. |
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;
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the readOptions. |
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. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()
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 |
Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeEndTime(Timestamp value)
public ExecuteChangeStreamQuery.Builder mergeEndTime(Timestamp value)
Specifies that records with commit_timestamp less than or equal to end_time should be returned.
optional .google.protobuf.Timestamp end_time = 3;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecuteChangeStreamQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ExecuteChangeStreamQuery.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
mergeFrom(ExecuteChangeStreamQuery other)
public ExecuteChangeStreamQuery.Builder mergeFrom(ExecuteChangeStreamQuery other)
Parameter | |
---|---|
Name | Description |
other |
ExecuteChangeStreamQuery |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
mergeStartTime(Timestamp value)
public ExecuteChangeStreamQuery.Builder mergeStartTime(Timestamp value)
Specifies that records with commit_timestamp greater than or equal to start_time should be returned.
.google.protobuf.Timestamp start_time = 2;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteChangeStreamQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
setCloudDatabaseRole(String value)
public ExecuteChangeStreamQuery.Builder setCloudDatabaseRole(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The cloudDatabaseRole to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setCloudDatabaseRoleBytes(ByteString value)
public ExecuteChangeStreamQuery.Builder setCloudDatabaseRoleBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for cloudDatabaseRole to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setDeadlineSeconds(long value)
public ExecuteChangeStreamQuery.Builder setDeadlineSeconds(long value)
Deadline for this change stream query, in seconds.
optional int64 deadline_seconds = 7;
Parameter | |
---|---|
Name | Description |
value |
long The deadlineSeconds to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setEndTime(Timestamp value)
public ExecuteChangeStreamQuery.Builder setEndTime(Timestamp value)
Specifies that records with commit_timestamp less than or equal to end_time should be returned.
optional .google.protobuf.Timestamp end_time = 3;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
setEndTime(Timestamp.Builder builderForValue)
public ExecuteChangeStreamQuery.Builder setEndTime(Timestamp.Builder builderForValue)
Specifies that records with commit_timestamp less than or equal to end_time should be returned.
optional .google.protobuf.Timestamp end_time = 3;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ExecuteChangeStreamQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
setHeartbeatMilliseconds(int value)
public ExecuteChangeStreamQuery.Builder setHeartbeatMilliseconds(int value)
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;
Parameter | |
---|---|
Name | Description |
value |
int The heartbeatMilliseconds to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setName(String value)
public ExecuteChangeStreamQuery.Builder setName(String value)
Name for this change stream.
string name = 1;
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public ExecuteChangeStreamQuery.Builder setNameBytes(ByteString value)
Name for this change stream.
string name = 1;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setPartitionToken(String value)
public ExecuteChangeStreamQuery.Builder setPartitionToken(String value)
Specifies which change stream partition to query, based on the content of child partitions records.
optional string partition_token = 4;
Parameter | |
---|---|
Name | Description |
value |
String The partitionToken to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setPartitionTokenBytes(ByteString value)
public ExecuteChangeStreamQuery.Builder setPartitionTokenBytes(ByteString value)
Specifies which change stream partition to query, based on the content of child partitions records.
optional string partition_token = 4;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for partitionToken to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setReadOptions(int index, String value)
public ExecuteChangeStreamQuery.Builder setReadOptions(int index, String value)
Read options for this change stream query.
repeated string read_options = 5;
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The readOptions to set. |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExecuteChangeStreamQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
setStartTime(Timestamp value)
public ExecuteChangeStreamQuery.Builder setStartTime(Timestamp value)
Specifies that records with commit_timestamp greater than or equal to start_time should be returned.
.google.protobuf.Timestamp start_time = 2;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
setStartTime(Timestamp.Builder builderForValue)
public ExecuteChangeStreamQuery.Builder setStartTime(Timestamp.Builder builderForValue)
Specifies that records with commit_timestamp greater than or equal to start_time should be returned.
.google.protobuf.Timestamp start_time = 2;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteChangeStreamQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExecuteChangeStreamQuery.Builder |