@google-cloud/datastore
Version:
Cloud Datastore Client Library for Node.js
933 lines (768 loc) • 853 kB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace datastore. */
namespace datastore {
/** Namespace admin. */
namespace admin {
/** Namespace v1. */
namespace v1 {
/** Represents a DatastoreAdmin */
class DatastoreAdmin extends $protobuf.rpc.Service {
/**
* Constructs a new DatastoreAdmin service.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
*/
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
/**
* Creates new DatastoreAdmin service using the specified rpc implementation.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
* @returns RPC service. Useful where requests and/or responses are streamed.
*/
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DatastoreAdmin;
/**
* Calls ExportEntities.
* @param request ExportEntitiesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public exportEntities(request: google.datastore.admin.v1.IExportEntitiesRequest, callback: google.datastore.admin.v1.DatastoreAdmin.ExportEntitiesCallback): void;
/**
* Calls ExportEntities.
* @param request ExportEntitiesRequest message or plain object
* @returns Promise
*/
public exportEntities(request: google.datastore.admin.v1.IExportEntitiesRequest): Promise<google.longrunning.Operation>;
/**
* Calls ImportEntities.
* @param request ImportEntitiesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public importEntities(request: google.datastore.admin.v1.IImportEntitiesRequest, callback: google.datastore.admin.v1.DatastoreAdmin.ImportEntitiesCallback): void;
/**
* Calls ImportEntities.
* @param request ImportEntitiesRequest message or plain object
* @returns Promise
*/
public importEntities(request: google.datastore.admin.v1.IImportEntitiesRequest): Promise<google.longrunning.Operation>;
/**
* Calls CreateIndex.
* @param request CreateIndexRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public createIndex(request: google.datastore.admin.v1.ICreateIndexRequest, callback: google.datastore.admin.v1.DatastoreAdmin.CreateIndexCallback): void;
/**
* Calls CreateIndex.
* @param request CreateIndexRequest message or plain object
* @returns Promise
*/
public createIndex(request: google.datastore.admin.v1.ICreateIndexRequest): Promise<google.longrunning.Operation>;
/**
* Calls DeleteIndex.
* @param request DeleteIndexRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public deleteIndex(request: google.datastore.admin.v1.IDeleteIndexRequest, callback: google.datastore.admin.v1.DatastoreAdmin.DeleteIndexCallback): void;
/**
* Calls DeleteIndex.
* @param request DeleteIndexRequest message or plain object
* @returns Promise
*/
public deleteIndex(request: google.datastore.admin.v1.IDeleteIndexRequest): Promise<google.longrunning.Operation>;
/**
* Calls GetIndex.
* @param request GetIndexRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Index
*/
public getIndex(request: google.datastore.admin.v1.IGetIndexRequest, callback: google.datastore.admin.v1.DatastoreAdmin.GetIndexCallback): void;
/**
* Calls GetIndex.
* @param request GetIndexRequest message or plain object
* @returns Promise
*/
public getIndex(request: google.datastore.admin.v1.IGetIndexRequest): Promise<google.datastore.admin.v1.Index>;
/**
* Calls ListIndexes.
* @param request ListIndexesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListIndexesResponse
*/
public listIndexes(request: google.datastore.admin.v1.IListIndexesRequest, callback: google.datastore.admin.v1.DatastoreAdmin.ListIndexesCallback): void;
/**
* Calls ListIndexes.
* @param request ListIndexesRequest message or plain object
* @returns Promise
*/
public listIndexes(request: google.datastore.admin.v1.IListIndexesRequest): Promise<google.datastore.admin.v1.ListIndexesResponse>;
}
namespace DatastoreAdmin {
/**
* Callback as used by {@link google.datastore.admin.v1.DatastoreAdmin|exportEntities}.
* @param error Error, if any
* @param [response] Operation
*/
type ExportEntitiesCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.datastore.admin.v1.DatastoreAdmin|importEntities}.
* @param error Error, if any
* @param [response] Operation
*/
type ImportEntitiesCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.datastore.admin.v1.DatastoreAdmin|createIndex}.
* @param error Error, if any
* @param [response] Operation
*/
type CreateIndexCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.datastore.admin.v1.DatastoreAdmin|deleteIndex}.
* @param error Error, if any
* @param [response] Operation
*/
type DeleteIndexCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.datastore.admin.v1.DatastoreAdmin|getIndex}.
* @param error Error, if any
* @param [response] Index
*/
type GetIndexCallback = (error: (Error|null), response?: google.datastore.admin.v1.Index) => void;
/**
* Callback as used by {@link google.datastore.admin.v1.DatastoreAdmin|listIndexes}.
* @param error Error, if any
* @param [response] ListIndexesResponse
*/
type ListIndexesCallback = (error: (Error|null), response?: google.datastore.admin.v1.ListIndexesResponse) => void;
}
/** Properties of a CommonMetadata. */
interface ICommonMetadata {
/** CommonMetadata startTime */
startTime?: (google.protobuf.ITimestamp|null);
/** CommonMetadata endTime */
endTime?: (google.protobuf.ITimestamp|null);
/** CommonMetadata operationType */
operationType?: (google.datastore.admin.v1.OperationType|keyof typeof google.datastore.admin.v1.OperationType|null);
/** CommonMetadata labels */
labels?: ({ [k: string]: string }|null);
/** CommonMetadata state */
state?: (google.datastore.admin.v1.CommonMetadata.State|keyof typeof google.datastore.admin.v1.CommonMetadata.State|null);
}
/** Represents a CommonMetadata. */
class CommonMetadata implements ICommonMetadata {
/**
* Constructs a new CommonMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.datastore.admin.v1.ICommonMetadata);
/** CommonMetadata startTime. */
public startTime?: (google.protobuf.ITimestamp|null);
/** CommonMetadata endTime. */
public endTime?: (google.protobuf.ITimestamp|null);
/** CommonMetadata operationType. */
public operationType: (google.datastore.admin.v1.OperationType|keyof typeof google.datastore.admin.v1.OperationType);
/** CommonMetadata labels. */
public labels: { [k: string]: string };
/** CommonMetadata state. */
public state: (google.datastore.admin.v1.CommonMetadata.State|keyof typeof google.datastore.admin.v1.CommonMetadata.State);
/**
* Creates a new CommonMetadata instance using the specified properties.
* @param [properties] Properties to set
* @returns CommonMetadata instance
*/
public static create(properties?: google.datastore.admin.v1.ICommonMetadata): google.datastore.admin.v1.CommonMetadata;
/**
* Encodes the specified CommonMetadata message. Does not implicitly {@link google.datastore.admin.v1.CommonMetadata.verify|verify} messages.
* @param message CommonMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.datastore.admin.v1.ICommonMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CommonMetadata message, length delimited. Does not implicitly {@link google.datastore.admin.v1.CommonMetadata.verify|verify} messages.
* @param message CommonMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.datastore.admin.v1.ICommonMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CommonMetadata message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CommonMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.datastore.admin.v1.CommonMetadata;
/**
* Decodes a CommonMetadata message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CommonMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.datastore.admin.v1.CommonMetadata;
/**
* Verifies a CommonMetadata message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a CommonMetadata message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CommonMetadata
*/
public static fromObject(object: { [k: string]: any }): google.datastore.admin.v1.CommonMetadata;
/**
* Creates a plain object from a CommonMetadata message. Also converts values to other types if specified.
* @param message CommonMetadata
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.datastore.admin.v1.CommonMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CommonMetadata to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CommonMetadata
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace CommonMetadata {
/** State enum. */
enum State {
STATE_UNSPECIFIED = 0,
INITIALIZING = 1,
PROCESSING = 2,
CANCELLING = 3,
FINALIZING = 4,
SUCCESSFUL = 5,
FAILED = 6,
CANCELLED = 7
}
}
/** Properties of a Progress. */
interface IProgress {
/** Progress workCompleted */
workCompleted?: (number|Long|string|null);
/** Progress workEstimated */
workEstimated?: (number|Long|string|null);
}
/** Represents a Progress. */
class Progress implements IProgress {
/**
* Constructs a new Progress.
* @param [properties] Properties to set
*/
constructor(properties?: google.datastore.admin.v1.IProgress);
/** Progress workCompleted. */
public workCompleted: (number|Long|string);
/** Progress workEstimated. */
public workEstimated: (number|Long|string);
/**
* Creates a new Progress instance using the specified properties.
* @param [properties] Properties to set
* @returns Progress instance
*/
public static create(properties?: google.datastore.admin.v1.IProgress): google.datastore.admin.v1.Progress;
/**
* Encodes the specified Progress message. Does not implicitly {@link google.datastore.admin.v1.Progress.verify|verify} messages.
* @param message Progress message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.datastore.admin.v1.IProgress, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Progress message, length delimited. Does not implicitly {@link google.datastore.admin.v1.Progress.verify|verify} messages.
* @param message Progress message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.datastore.admin.v1.IProgress, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a Progress message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Progress
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.datastore.admin.v1.Progress;
/**
* Decodes a Progress message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Progress
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.datastore.admin.v1.Progress;
/**
* Verifies a Progress message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a Progress message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Progress
*/
public static fromObject(object: { [k: string]: any }): google.datastore.admin.v1.Progress;
/**
* Creates a plain object from a Progress message. Also converts values to other types if specified.
* @param message Progress
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.datastore.admin.v1.Progress, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Progress to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Progress
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an ExportEntitiesRequest. */
interface IExportEntitiesRequest {
/** ExportEntitiesRequest projectId */
projectId?: (string|null);
/** ExportEntitiesRequest labels */
labels?: ({ [k: string]: string }|null);
/** ExportEntitiesRequest entityFilter */
entityFilter?: (google.datastore.admin.v1.IEntityFilter|null);
/** ExportEntitiesRequest outputUrlPrefix */
outputUrlPrefix?: (string|null);
}
/** Represents an ExportEntitiesRequest. */
class ExportEntitiesRequest implements IExportEntitiesRequest {
/**
* Constructs a new ExportEntitiesRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.datastore.admin.v1.IExportEntitiesRequest);
/** ExportEntitiesRequest projectId. */
public projectId: string;
/** ExportEntitiesRequest labels. */
public labels: { [k: string]: string };
/** ExportEntitiesRequest entityFilter. */
public entityFilter?: (google.datastore.admin.v1.IEntityFilter|null);
/** ExportEntitiesRequest outputUrlPrefix. */
public outputUrlPrefix: string;
/**
* Creates a new ExportEntitiesRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns ExportEntitiesRequest instance
*/
public static create(properties?: google.datastore.admin.v1.IExportEntitiesRequest): google.datastore.admin.v1.ExportEntitiesRequest;
/**
* Encodes the specified ExportEntitiesRequest message. Does not implicitly {@link google.datastore.admin.v1.ExportEntitiesRequest.verify|verify} messages.
* @param message ExportEntitiesRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.datastore.admin.v1.IExportEntitiesRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ExportEntitiesRequest message, length delimited. Does not implicitly {@link google.datastore.admin.v1.ExportEntitiesRequest.verify|verify} messages.
* @param message ExportEntitiesRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.datastore.admin.v1.IExportEntitiesRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an ExportEntitiesRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ExportEntitiesRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.datastore.admin.v1.ExportEntitiesRequest;
/**
* Decodes an ExportEntitiesRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ExportEntitiesRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.datastore.admin.v1.ExportEntitiesRequest;
/**
* Verifies an ExportEntitiesRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an ExportEntitiesRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ExportEntitiesRequest
*/
public static fromObject(object: { [k: string]: any }): google.datastore.admin.v1.ExportEntitiesRequest;
/**
* Creates a plain object from an ExportEntitiesRequest message. Also converts values to other types if specified.
* @param message ExportEntitiesRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.datastore.admin.v1.ExportEntitiesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ExportEntitiesRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ExportEntitiesRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an ImportEntitiesRequest. */
interface IImportEntitiesRequest {
/** ImportEntitiesRequest projectId */
projectId?: (string|null);
/** ImportEntitiesRequest labels */
labels?: ({ [k: string]: string }|null);
/** ImportEntitiesRequest inputUrl */
inputUrl?: (string|null);
/** ImportEntitiesRequest entityFilter */
entityFilter?: (google.datastore.admin.v1.IEntityFilter|null);
}
/** Represents an ImportEntitiesRequest. */
class ImportEntitiesRequest implements IImportEntitiesRequest {
/**
* Constructs a new ImportEntitiesRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.datastore.admin.v1.IImportEntitiesRequest);
/** ImportEntitiesRequest projectId. */
public projectId: string;
/** ImportEntitiesRequest labels. */
public labels: { [k: string]: string };
/** ImportEntitiesRequest inputUrl. */
public inputUrl: string;
/** ImportEntitiesRequest entityFilter. */
public entityFilter?: (google.datastore.admin.v1.IEntityFilter|null);
/**
* Creates a new ImportEntitiesRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns ImportEntitiesRequest instance
*/
public static create(properties?: google.datastore.admin.v1.IImportEntitiesRequest): google.datastore.admin.v1.ImportEntitiesRequest;
/**
* Encodes the specified ImportEntitiesRequest message. Does not implicitly {@link google.datastore.admin.v1.ImportEntitiesRequest.verify|verify} messages.
* @param message ImportEntitiesRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.datastore.admin.v1.IImportEntitiesRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ImportEntitiesRequest message, length delimited. Does not implicitly {@link google.datastore.admin.v1.ImportEntitiesRequest.verify|verify} messages.
* @param message ImportEntitiesRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.datastore.admin.v1.IImportEntitiesRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an ImportEntitiesRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ImportEntitiesRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.datastore.admin.v1.ImportEntitiesRequest;
/**
* Decodes an ImportEntitiesRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ImportEntitiesRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.datastore.admin.v1.ImportEntitiesRequest;
/**
* Verifies an ImportEntitiesRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an ImportEntitiesRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ImportEntitiesRequest
*/
public static fromObject(object: { [k: string]: any }): google.datastore.admin.v1.ImportEntitiesRequest;
/**
* Creates a plain object from an ImportEntitiesRequest message. Also converts values to other types if specified.
* @param message ImportEntitiesRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.datastore.admin.v1.ImportEntitiesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ImportEntitiesRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ImportEntitiesRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an ExportEntitiesResponse. */
interface IExportEntitiesResponse {
/** ExportEntitiesResponse outputUrl */
outputUrl?: (string|null);
}
/** Represents an ExportEntitiesResponse. */
class ExportEntitiesResponse implements IExportEntitiesResponse {
/**
* Constructs a new ExportEntitiesResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.datastore.admin.v1.IExportEntitiesResponse);
/** ExportEntitiesResponse outputUrl. */
public outputUrl: string;
/**
* Creates a new ExportEntitiesResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns ExportEntitiesResponse instance
*/
public static create(properties?: google.datastore.admin.v1.IExportEntitiesResponse): google.datastore.admin.v1.ExportEntitiesResponse;
/**
* Encodes the specified ExportEntitiesResponse message. Does not implicitly {@link google.datastore.admin.v1.ExportEntitiesResponse.verify|verify} messages.
* @param message ExportEntitiesResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.datastore.admin.v1.IExportEntitiesResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ExportEntitiesResponse message, length delimited. Does not implicitly {@link google.datastore.admin.v1.ExportEntitiesResponse.verify|verify} messages.
* @param message ExportEntitiesResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.datastore.admin.v1.IExportEntitiesResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an ExportEntitiesResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ExportEntitiesResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.datastore.admin.v1.ExportEntitiesResponse;
/**
* Decodes an ExportEntitiesResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ExportEntitiesResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.datastore.admin.v1.ExportEntitiesResponse;
/**
* Verifies an ExportEntitiesResponse message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an ExportEntitiesResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ExportEntitiesResponse
*/
public static fromObject(object: { [k: string]: any }): google.datastore.admin.v1.ExportEntitiesResponse;
/**
* Creates a plain object from an ExportEntitiesResponse message. Also converts values to other types if specified.
* @param message ExportEntitiesResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.datastore.admin.v1.ExportEntitiesResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ExportEntitiesResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ExportEntitiesResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an ExportEntitiesMetadata. */
interface IExportEntitiesMetadata {
/** ExportEntitiesMetadata common */
common?: (google.datastore.admin.v1.ICommonMetadata|null);
/** ExportEntitiesMetadata progressEntities */
progressEntities?: (google.datastore.admin.v1.IProgress|null);
/** ExportEntitiesMetadata progressBytes */
progressBytes?: (google.datastore.admin.v1.IProgress|null);
/** ExportEntitiesMetadata entityFilter */
entityFilter?: (google.datastore.admin.v1.IEntityFilter|null);
/** ExportEntitiesMetadata outputUrlPrefix */
outputUrlPrefix?: (string|null);
}
/** Represents an ExportEntitiesMetadata. */
class ExportEntitiesMetadata implements IExportEntitiesMetadata {
/**
* Constructs a new ExportEntitiesMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.datastore.admin.v1.IExportEntitiesMetadata);
/** ExportEntitiesMetadata common. */
public common?: (google.datastore.admin.v1.ICommonMetadata|null);
/** ExportEntitiesMetadata progressEntities. */
public progressEntities?: (google.datastore.admin.v1.IProgress|null);
/** ExportEntitiesMetadata progressBytes. */
public progressBytes?: (google.datastore.admin.v1.IProgress|null);
/** ExportEntitiesMetadata entityFilter. */
public entityFilter?: (google.datastore.admin.v1.IEntityFilter|null);
/** ExportEntitiesMetadata outputUrlPrefix. */
public outputUrlPrefix: string;
/**
* Creates a new ExportEntitiesMetadata instance using the specified properties.
* @param [properties] Properties to set
* @returns ExportEntitiesMetadata instance
*/
public static create(properties?: google.datastore.admin.v1.IExportEntitiesMetadata): google.datastore.admin.v1.ExportEntitiesMetadata;
/**
* Encodes the specified ExportEntitiesMetadata message. Does not implicitly {@link google.datastore.admin.v1.ExportEntitiesMetadata.verify|verify} messages.
* @param message ExportEntitiesMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.datastore.admin.v1.IExportEntitiesMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ExportEntitiesMetadata message, length delimited. Does not implicitly {@link google.datastore.admin.v1.ExportEntitiesMetadata.verify|verify} messages.
* @param message ExportEntitiesMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.datastore.admin.v1.IExportEntitiesMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an ExportEntitiesMetadata message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ExportEntitiesMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.datastore.admin.v1.ExportEntitiesMetadata;
/**
* Decodes an ExportEntitiesMetadata message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ExportEntitiesMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.datastore.admin.v1.ExportEntitiesMetadata;
/**
* Verifies an ExportEntitiesMetadata message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an ExportEntitiesMetadata message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ExportEntitiesMetadata
*/
public static fromObject(object: { [k: string]: any }): google.datastore.admin.v1.ExportEntitiesMetadata;
/**
* Creates a plain object from an ExportEntitiesMetadata message. Also converts values to other types if specified.
* @param message ExportEntitiesMetadata
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.datastore.admin.v1.ExportEntitiesMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ExportEntitiesMetadata to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ExportEntitiesMetadata
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an ImportEntitiesMetadata. */
interface IImportEntitiesMetadata {
/** ImportEntitiesMetadata common */
common?: (google.datastore.admin.v1.ICommonMetadata|null);
/** ImportEntitiesMetadata progressEntities */
progressEntities?: (google.datastore.admin.v1.IProgress|null);
/** ImportEntitiesMetadata progressBytes */
progressBytes?: (google.datastore.admin.v1.IProgress|null);
/** ImportEntitiesMetadata entityFilter */
entityFilter?: (google.datastore.admin.v1.IEntityFilter|null);
/** ImportEntitiesMetadata inputUrl */
inputUrl?: (string|null);
}
/** Represents an ImportEntitiesMetadata. */
class ImportEntitiesMetadata implements IImportEntitiesMetadata {
/**
* Constructs a new ImportEntitiesMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.datastore.admin.v1.IImportEntitiesMetadata);
/** ImportEntitiesMetadata common. */
public common?: (google.datastore.admin.v1.ICommonMetadata|null);
/** ImportEntitiesMetadata progressEntities. */
public progressEntities?: (google.datastore.admin.v1.IProgress|null);
/** ImportEntitiesMetadata progressBytes. */
public progressBytes?: (google.datastore.admin.v1.IProgress|null);
/** ImportEntitiesMetadata entityFilter. */
public entityFilter?: (google.datastore.admin.v1.IEntityFilter|null);
/** ImportEntitiesMetadata inputUrl. */
public inputUrl: string;
/**
* Creates a new ImportEntitiesMetadata instance using the specified properties.
* @param [properties] Properties to set
* @returns ImportEntitiesMetadata instance
*/
public static create(properties?: google.datastore.admin.v1.IImportEntitiesMetadata): google.datastore.admin.v1.ImportEntitiesMetadata;
/**
* Encodes the specified ImportEntitiesMetadata message. Does not implicitly {@link google.datastore.admin.v1.ImportEntitiesMetadata.verify|verify} messages.
* @param message ImportEntitiesMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.datastore.admin.v1.IImportEntitiesMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ImportEntitiesMetadata message, length delimited. Does not implicitly {@link google.datastore.admin.v1.ImportEntitiesMetadata.verify|verify} messages.
* @param message ImportEntitiesMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.datastore.admin.v1.IImportEntitiesMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
*