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 :Array.<google.datastore.v1.IPropertyReference>

Query distinctOn.

endCursor :Uint8Array

Query endCursor.

filter :google.datastore.v1.IFilter|null|undefined

Query filter.

kind :Array.<google.datastore.v1.IKindExpression>

Query kind.

limit :google.protobuf.IInt32Value|null|undefined

Query limit.

offset :number

Query offset.

order :Array.<google.datastore.v1.IPropertyOrder>

Query order.

projection :Array.<google.datastore.v1.IProjection>

Query projection.

startCursor :Uint8Array

Query startCursor.

Methods

(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

(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

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

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

(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

(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

(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

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

Verifies a Query message.

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

Plain object to verify

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

Converts this Query to JSON.