QueryResultBatch

google.datastore.v1. QueryResultBatch

Represents a QueryResultBatch.

Constructor

new QueryResultBatch(propertiesopt)

Constructs a new QueryResultBatch.

Parameters:
Name Type Attributes Description
properties google.datastore.v1.IQueryResultBatch <optional>

Properties to set

Implements:
  • IQueryResultBatch

Members

endCursor

QueryResultBatch endCursor.

entityResultType

QueryResultBatch entityResultType.

entityResults

QueryResultBatch entityResults.

moreResults

QueryResultBatch moreResults.

readTime

QueryResultBatch readTime.

skippedCursor

QueryResultBatch skippedCursor.

skippedResults

QueryResultBatch skippedResults.

snapshotVersion

QueryResultBatch snapshotVersion.

MoreResultsType

MoreResultsType enum.

Properties:
Name Type Description
MORE_RESULTS_TYPE_UNSPECIFIED number

MORE_RESULTS_TYPE_UNSPECIFIED value

NOT_FINISHED number

NOT_FINISHED value

MORE_RESULTS_AFTER_LIMIT number

MORE_RESULTS_AFTER_LIMIT value

MORE_RESULTS_AFTER_CURSOR number

MORE_RESULTS_AFTER_CURSOR value

NO_MORE_RESULTS number

NO_MORE_RESULTS value

Methods

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

Converts this QueryResultBatch to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.datastore.v1.QueryResultBatch}

Creates a new QueryResultBatch instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.datastore.v1.IQueryResultBatch <optional>

Properties to set

Returns:
Type Description
google.datastore.v1.QueryResultBatch

QueryResultBatch instance

(static) decode(reader, lengthopt) → {google.datastore.v1.QueryResultBatch}

Decodes a QueryResultBatch 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.datastore.v1.QueryResultBatch

QueryResultBatch

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.datastore.v1.QueryResultBatch}

Decodes a QueryResultBatch 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.datastore.v1.QueryResultBatch

QueryResultBatch

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 QueryResultBatch message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.datastore.v1.IQueryResultBatch

QueryResultBatch 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 QueryResultBatch message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.datastore.v1.IQueryResultBatch

QueryResultBatch message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.datastore.v1.QueryResultBatch}

Creates a QueryResultBatch 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.datastore.v1.QueryResultBatch

QueryResultBatch

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for QueryResultBatch

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 QueryResultBatch message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.datastore.v1.QueryResultBatch

QueryResultBatch

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a QueryResultBatch 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