Represents a Query.
Implements
Package
@google-cloud/datastore-apiConstructors
(constructor)(properties)
constructor(properties?: google.datastore.v1.IQuery);Constructs a new Query.
| Parameter | |
|---|---|
| Name | Description |
properties |
IQuery
Properties to set |
Properties
distinctOn
public distinctOn: google.datastore.v1.IPropertyReference[];Query distinctOn.
endCursor
public endCursor: (Uint8Array|Buffer|string);Query endCursor.
filter
public filter?: (google.datastore.v1.IFilter|null);Query filter.
findNearest
public findNearest?: (google.datastore.v1.IFindNearest|null);Query findNearest.
kind
public kind: google.datastore.v1.IKindExpression[];Query kind.
limit
public limit?: (google.protobuf.IInt32Value|null);Query limit.
offset
public offset: number;Query offset.
order
public order: google.datastore.v1.IPropertyOrder[];Query order.
projection
public projection: google.datastore.v1.IProjection[];Query projection.
startCursor
public startCursor: (Uint8Array|Buffer|string);Query startCursor.
Methods
create(properties)
public static create(properties?: google.datastore.v1.IQuery): google.datastore.v1.Query;Creates a new Query instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IQuery
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Query |
Query instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.datastore.v1.Query;Decodes a Query message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Query |
Query |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.datastore.v1.Query;Decodes a Query message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Query |
Query |
encode(message, writer)
public static encode(message: google.datastore.v1.IQuery, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Query message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IQuery
Query message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.datastore.v1.IQuery, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Query message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IQuery
Query message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.datastore.v1.Query;Creates a Query message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Query |
Query |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Query
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Query to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.datastore.v1.Query, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Query message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Query
Query |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Query message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|