Interface PartialResultSetOrBuilder (6.79.0)

Version 6.79.0

• 6.80.1 (latest)
• 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 interface PartialResultSetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChunkedValue()

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

getMetadata()

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

getMetadataOrBuilder()

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

getPrecommitToken()

public abstract MultiplexedSessionPrecommitToken getPrecommitToken()

Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
MultiplexedSessionPrecommitToken	The precommitToken.

getPrecommitTokenOrBuilder()

public abstract MultiplexedSessionPrecommitTokenOrBuilder getPrecommitTokenOrBuilder()

Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
MultiplexedSessionPrecommitTokenOrBuilder

getResumeToken()

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

getStatsOrBuilder()

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

getValuesCount()

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

hasPrecommitToken()

public abstract boolean hasPrecommitToken()

Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. This feature is not yet supported and will result in an UNIMPLEMENTED error.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the precommitToken field is set.

hasStats()

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