Class PartialResultSet.Builder (6.55.0)

Version 6.55.0

• 6.83.0 (latest)
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public static final class PartialResultSet.Builder extends GeneratedMessageV3.Builder<PartialResultSet.Builder> implements PartialResultSetOrBuilder

Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

Protobuf type google.spanner.v1.PartialResultSet

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartialResultSet.Builder

Implements

PartialResultSetOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllValues(Iterable<? extends Value> values)

public PartialResultSet.Builder addAllValues(Iterable<? extends Value> values)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name	Description
values	Iterable<? extends com.google.protobuf.Value>

Returns
Type	Description
PartialResultSet.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PartialResultSet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addValues(Value value)

public PartialResultSet.Builder addValues(Value value)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name	Description
value	Value

Returns
Type	Description
PartialResultSet.Builder

addValues(Value.Builder builderForValue)

public PartialResultSet.Builder addValues(Value.Builder builderForValue)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
PartialResultSet.Builder

addValues(int index, Value value)

public PartialResultSet.Builder addValues(int index, Value value)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
PartialResultSet.Builder

addValues(int index, Value.Builder builderForValue)

public PartialResultSet.Builder addValues(int index, Value.Builder builderForValue)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameters
Name	Description
index	int
builderForValue	Builder

Returns
Type	Description
PartialResultSet.Builder

addValuesBuilder()

public Value.Builder addValuesBuilder()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type	Description
Builder

addValuesBuilder(int index)

public Value.Builder addValuesBuilder(int index)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Builder

build()

public PartialResultSet build()

Returns
Type	Description
PartialResultSet

buildPartial()

public PartialResultSet buildPartial()

Returns
Type	Description
PartialResultSet

clear()

public PartialResultSet.Builder clear()

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearChunkedValue()

public PartialResultSet.Builder clearChunkedValue()

If true, then the final value in values is chunked, and must be combined with more values from subsequent PartialResultSets to obtain a complete field value.

bool chunked_value = 3;

Returns
Type	Description
PartialResultSet.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PartialResultSet.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMetadata()

public PartialResultSet.Builder clearMetadata()

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type	Description
PartialResultSet.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PartialResultSet.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearResumeToken()

public PartialResultSet.Builder clearResumeToken()

Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including resume_token. Note that executing any other transaction in the same session invalidates the token.

bytes resume_token = 4;

Returns
Type	Description
PartialResultSet.Builder	This builder for chaining.

clearStats()

public PartialResultSet.Builder clearStats()

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Returns
Type	Description
PartialResultSet.Builder

clearValues()

public PartialResultSet.Builder clearValues()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type	Description
PartialResultSet.Builder

clone()

public PartialResultSet.Builder clone()

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getChunkedValue()

public boolean getChunkedValue()

If true, then the final value in values is chunked, and must be combined with more values from subsequent PartialResultSets to obtain a complete field value.

bool chunked_value = 3;

Returns
Type	Description
boolean	The chunkedValue.

getDefaultInstanceForType()

public PartialResultSet getDefaultInstanceForType()

Returns
Type	Description
PartialResultSet

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMetadata()

public ResultSetMetadata getMetadata()

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type	Description
ResultSetMetadata	The metadata.

getMetadataBuilder()

public ResultSetMetadata.Builder getMetadataBuilder()

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type	Description
ResultSetMetadata.Builder

getMetadataOrBuilder()

public ResultSetMetadataOrBuilder getMetadataOrBuilder()

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type	Description
ResultSetMetadataOrBuilder

getResumeToken()

public ByteString getResumeToken()

Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including resume_token. Note that executing any other transaction in the same session invalidates the token.

bytes resume_token = 4;

Returns
Type	Description
ByteString	The resumeToken.

getStats()

public ResultSetStats getStats()

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Returns
Type	Description
ResultSetStats	The stats.

getStatsBuilder()

public ResultSetStats.Builder getStatsBuilder()

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Returns
Type	Description
ResultSetStats.Builder

getStatsOrBuilder()

public ResultSetStatsOrBuilder getStatsOrBuilder()

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Returns
Type	Description
ResultSetStatsOrBuilder

getValues(int index)

public Value getValues(int index)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Value

getValuesBuilder(int index)

public Value.Builder getValuesBuilder(int index)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Builder

getValuesBuilderList()

public List<Value.Builder> getValuesBuilderList()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type	Description
List<Builder>

getValuesCount()

public int getValuesCount()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type	Description
int

getValuesList()

public List<Value> getValuesList()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type	Description
List<Value>

getValuesOrBuilder(int index)

public ValueOrBuilder getValuesOrBuilder(int index)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
ValueOrBuilder

getValuesOrBuilderList()

public List<? extends ValueOrBuilder> getValuesOrBuilderList()

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Returns
Type	Description
List<? extends com.google.protobuf.ValueOrBuilder>

hasMetadata()

public boolean hasMetadata()

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type	Description
boolean	Whether the metadata field is set.

hasStats()

public boolean hasStats()

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Returns
Type	Description
boolean	Whether the stats field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PartialResultSet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PartialResultSet.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public PartialResultSet.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
PartialResultSet.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(PartialResultSet other)

public PartialResultSet.Builder mergeFrom(PartialResultSet other)

Parameter
Name	Description
other	PartialResultSet

Returns
Type	Description
PartialResultSet.Builder

mergeMetadata(ResultSetMetadata value)

public PartialResultSet.Builder mergeMetadata(ResultSetMetadata value)

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Parameter
Name	Description
value	ResultSetMetadata

Returns
Type	Description
PartialResultSet.Builder

mergeStats(ResultSetStats value)

public PartialResultSet.Builder mergeStats(ResultSetStats value)

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Parameter
Name	Description
value	ResultSetStats

Returns
Type	Description
PartialResultSet.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PartialResultSet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeValues(int index)

public PartialResultSet.Builder removeValues(int index)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
PartialResultSet.Builder

setChunkedValue(boolean value)

public PartialResultSet.Builder setChunkedValue(boolean value)

If true, then the final value in values is chunked, and must be combined with more values from subsequent PartialResultSets to obtain a complete field value.

bool chunked_value = 3;

Parameter
Name	Description
value	boolean The chunkedValue to set.

Returns
Type	Description
PartialResultSet.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PartialResultSet.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMetadata(ResultSetMetadata value)

public PartialResultSet.Builder setMetadata(ResultSetMetadata value)

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Parameter
Name	Description
value	ResultSetMetadata

Returns
Type	Description
PartialResultSet.Builder

setMetadata(ResultSetMetadata.Builder builderForValue)

public PartialResultSet.Builder setMetadata(ResultSetMetadata.Builder builderForValue)

Metadata about the result set, such as row type information. Only present in the first response.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Parameter
Name	Description
builderForValue	ResultSetMetadata.Builder

Returns
Type	Description
PartialResultSet.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PartialResultSet.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setResumeToken(ByteString value)

public PartialResultSet.Builder setResumeToken(ByteString value)

Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including resume_token. Note that executing any other transaction in the same session invalidates the token.

bytes resume_token = 4;

Parameter
Name	Description
value	ByteString The resumeToken to set.

Returns
Type	Description
PartialResultSet.Builder	This builder for chaining.

setStats(ResultSetStats value)

public PartialResultSet.Builder setStats(ResultSetStats value)

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Parameter
Name	Description
value	ResultSetStats

Returns
Type	Description
PartialResultSet.Builder

setStats(ResultSetStats.Builder builderForValue)

public PartialResultSet.Builder setStats(ResultSetStats.Builder builderForValue)

Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements.

.google.spanner.v1.ResultSetStats stats = 5;

Parameter
Name	Description
builderForValue	ResultSetStats.Builder

Returns
Type	Description
PartialResultSet.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PartialResultSet.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
PartialResultSet.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setValues(int index, Value value)

public PartialResultSet.Builder setValues(int index, Value value)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
PartialResultSet.Builder

setValues(int index, Value.Builder builderForValue)

public PartialResultSet.Builder setValues(int index, Value.Builder builderForValue)

A streamed result set consists of a stream of values, which might be split into many PartialResultSet messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields.

Most values are encoded based on type as described here.

It is possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent PartialResultSet(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows:

• bool/number/null: cannot be chunked
• string: concatenate the strings
• list: concatenate the lists. If the last element in a list is a string, list, or object, merge it with the first element in the next list by applying these rules recursively.

• object: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values.

  Some examples of merging:

  Strings are concatenated.

  "foo", "bar" => "foobar"

  Lists of non-strings are concatenated.

  [2, 3], [4] => [2, 3, 4]

  Lists are concatenated, but the last and first elements are merged

  because they are strings.

  ["a", "b"], ["c", "d"] => ["a", "bc", "d"]

  Lists are concatenated, but the last and first elements are merged

  because they are lists. Recursively, the last and first elements

  of the inner lists are merged because they are strings.

  ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]

  Non-overlapping object fields are combined.

  {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}

  Overlapping object fields are merged.

  {"a": "1"}, {"a": "2"} => {"a": "12"}

  Examples of merging objects containing lists of strings.

  {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}

  For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following PartialResultSets might be yielded:

  { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true "resume_token": "Bqp2..." } { "values": ["d"] "resume_token": "Zx1B..." }

  This sequence of PartialResultSets encodes two rows, one containing the field value "Hello", and a second containing the field value "World" = "W" + "orl" + "d".

repeated .google.protobuf.Value values = 2;

Parameters
Name	Description
index	int
builderForValue	Builder

Returns
Type	Description
PartialResultSet.Builder