ResultSetMetadata

google.spanner.v1. ResultSetMetadata

Represents a ResultSetMetadata.

Constructor

new ResultSetMetadata(propertiesopt)

Constructs a new ResultSetMetadata.

Parameters:
Name Type Attributes Description
properties google.spanner.v1.IResultSetMetadata <optional>

Properties to set

Implements:
  • IResultSetMetadata

Members

rowType

ResultSetMetadata rowType.

transaction

ResultSetMetadata transaction.

undeclaredParameters

ResultSetMetadata undeclaredParameters.

Methods

toJSON() → {Object.<string, *>}

Converts this ResultSetMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.spanner.v1.ResultSetMetadata}

Creates a new ResultSetMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.spanner.v1.IResultSetMetadata <optional>

Properties to set

Returns:
Type Description
google.spanner.v1.ResultSetMetadata

ResultSetMetadata instance

(static) decode(reader, lengthopt) → {google.spanner.v1.ResultSetMetadata}

Decodes a ResultSetMetadata message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.spanner.v1.ResultSetMetadata

ResultSetMetadata

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.spanner.v1.ResultSetMetadata}

Decodes a ResultSetMetadata message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.spanner.v1.ResultSetMetadata

ResultSetMetadata

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified ResultSetMetadata message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.v1.IResultSetMetadata

ResultSetMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified ResultSetMetadata message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.v1.IResultSetMetadata

ResultSetMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.spanner.v1.ResultSetMetadata}

Creates a ResultSetMetadata message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.spanner.v1.ResultSetMetadata

ResultSetMetadata

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ResultSetMetadata

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a ResultSetMetadata message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.spanner.v1.ResultSetMetadata

ResultSetMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a ResultSetMetadata message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not