Query

google.datastore.v1. Query

Represents a Query.

Constructor

new Query(propertiesopt)

Constructs a new Query.

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

Properties to set

Implements:
  • IQuery

Members

distinctOn

Query distinctOn.

endCursor

Query endCursor.

filter

Query filter.

kind

Query kind.

limit

Query limit.

offset

Query offset.

order

Query order.

projection

Query projection.

startCursor

Query startCursor.

Methods

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

Converts this Query to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Query instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.datastore.v1.Query

Query instance

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

Decodes a Query 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.Query

Query

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.Query}

Decodes a Query 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.Query

Query

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

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

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

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

Query 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.Query}

Creates a Query 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.Query

Query

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Query

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

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

Query

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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