Class Index (8.7.0)
Stay organized with collections
Save and categorize content based on your preferences.
Package
@google-cloud/datastore
Example
const {Datastore} = require('@google-cloud/datastore');
const datastore = new Datastore();
const index = datastore.index('my-index');
Constructors
(constructor)(datastore, id)
constructor(datastore: Datastore, id: string);
Constructs a new instance of the Index
class
Parameters |
Name |
Description |
datastore |
Datastore
|
id |
string
|
Properties
datastore
id
Methods
get(gaxOptions)
get(gaxOptions?: CallOptions): Promise<GetIndexResponse>;
Get an index if it exists.
Returns |
Type |
Description |
Promise<GetIndexResponse> |
|
get(callback)
get(callback: GetIndexCallback): void;
Parameter |
Name |
Description |
callback |
GetIndexCallback
|
Returns |
Type |
Description |
void |
|
get(gaxOptions, callback)
get(gaxOptions: CallOptions, callback: GetIndexCallback): void;
Parameters |
Name |
Description |
gaxOptions |
CallOptions
|
callback |
GetIndexCallback
|
Returns |
Type |
Description |
void |
|
getMetadata(gaxOptions?: CallOptions): Promise<IndexGetMetadataResponse>;
Get the metadata of this index.
Returns |
Type |
Description |
Promise<IndexGetMetadataResponse> |
|
getMetadata(callback: IndexGetMetadataCallback): void;
Parameter |
Name |
Description |
callback |
IndexGetMetadataCallback
|
Returns |
Type |
Description |
void |
|
getMetadata(gaxOptions: CallOptions, callback: IndexGetMetadataCallback): void;
Parameters |
Name |
Description |
gaxOptions |
CallOptions
|
callback |
IndexGetMetadataCallback
|
Returns |
Type |
Description |
void |
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-24 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-09-24 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-24 UTC."]]