Class Index

Package

@google-cloud/datastore!

Constructors

(constructor)(datastore, id)

constructor(datastore: Datastore, id: string);

Constructs a new instance of the Index class

Parameters
TypeNameDescription
Datastoredatastore
stringid

Properties

datastore

datastore: Datastore;
Property Value
TypeDescription
Datastore

id

id: string;
Property Value
TypeDescription
string

metadata

metadata?: IIndex;
Property Value
TypeDescription
IIndex

Methods

get(gaxOptions)

get(gaxOptions?: CallOptions): Promise<GetIndexResponse>;
Parameter
TypeNameDescription
CallOptionsgaxOptions
Returns
TypeDescription
Promise<GetIndexResponse>

get(callback)

get(callback: GetIndexCallback): void;
Parameter
TypeNameDescription
GetIndexCallbackcallback
Returns
TypeDescription
void

get(gaxOptions, callback)

get(gaxOptions: CallOptions, callback: GetIndexCallback): void;
Parameters
TypeNameDescription
CallOptionsgaxOptions
GetIndexCallbackcallback
Returns
TypeDescription
void

getMetadata(gaxOptions)

getMetadata(gaxOptions?: CallOptions): Promise<IndexGetMetadataResponse>;
Parameter
TypeNameDescription
CallOptionsgaxOptions
Returns
TypeDescription
Promise<IndexGetMetadataResponse>

getMetadata(callback)

getMetadata(callback: IndexGetMetadataCallback): void;
Parameter
TypeNameDescription
IndexGetMetadataCallbackcallback
Returns
TypeDescription
void

getMetadata(gaxOptions, callback)

getMetadata(gaxOptions: CallOptions, callback: IndexGetMetadataCallback): void;
Parameters
TypeNameDescription
CallOptionsgaxOptions
IndexGetMetadataCallbackcallback
Returns
TypeDescription
void