RunQueryRequest

google.datastore.v1. RunQueryRequest

Represents a RunQueryRequest.

Constructor

new RunQueryRequest(propertiesopt)

Constructs a new RunQueryRequest.

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

Properties to set

Implements:
  • IRunQueryRequest

Members

databaseId

RunQueryRequest databaseId.

explainOptions

RunQueryRequest explainOptions.

gqlQuery

RunQueryRequest gqlQuery.

partitionId

RunQueryRequest partitionId.

projectId

RunQueryRequest projectId.

propertyMask

RunQueryRequest propertyMask.

query

RunQueryRequest query.

queryType

RunQueryRequest queryType.

readOptions

RunQueryRequest readOptions.

Methods

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

Converts this RunQueryRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new RunQueryRequest instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.datastore.v1.RunQueryRequest

RunQueryRequest instance

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

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

RunQueryRequest

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

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

RunQueryRequest

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

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

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

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

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

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

RunQueryRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for RunQueryRequest

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

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

RunQueryRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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