@google-cloud/firestore
Version:
Firestore Client Library for Node.js
1,317 lines (1,011 loc) • 375 kB
TypeScript
/*!
* Copyright 2024 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 * as $protobuf from "protobufjs";
/** Namespace google. */
export namespace google {
/** Namespace protobuf. */
namespace protobuf {
/** Properties of a Timestamp. */
interface ITimestamp {
/** Timestamp seconds */
seconds?: (number|string|null);
/** Timestamp nanos */
nanos?: (number|null);
}
/** Represents a Timestamp. */
class Timestamp implements ITimestamp {
/**
* Constructs a new Timestamp.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.ITimestamp);
/** Timestamp seconds. */
public seconds: (number|string);
/** Timestamp nanos. */
public nanos: number;
/**
* Creates a Timestamp message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Timestamp
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.Timestamp;
/**
* Creates a plain object from a Timestamp message. Also converts values to other types if specified.
* @param message Timestamp
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.Timestamp, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Timestamp to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Timestamp
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a Struct. */
interface IStruct {
/** Struct fields */
fields?: ({ [k: string]: google.protobuf.IValue }|null);
}
/** Represents a Struct. */
class Struct implements IStruct {
/**
* Constructs a new Struct.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IStruct);
/** Struct fields. */
public fields: { [k: string]: google.protobuf.IValue };
/**
* Creates a Struct message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Struct
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.Struct;
/**
* Creates a plain object from a Struct message. Also converts values to other types if specified.
* @param message Struct
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.Struct, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Struct to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Struct
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a Value. */
interface IValue {
/** Value nullValue */
nullValue?: (google.protobuf.NullValue|null);
/** Value numberValue */
numberValue?: (number|null);
/** Value stringValue */
stringValue?: (string|null);
/** Value boolValue */
boolValue?: (boolean|null);
/** Value structValue */
structValue?: (google.protobuf.IStruct|null);
/** Value listValue */
listValue?: (google.protobuf.IListValue|null);
}
/** Represents a Value. */
class Value implements IValue {
/**
* Constructs a new Value.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IValue);
/** Value nullValue. */
public nullValue?: (google.protobuf.NullValue|null);
/** Value numberValue. */
public numberValue?: (number|null);
/** Value stringValue. */
public stringValue?: (string|null);
/** Value boolValue. */
public boolValue?: (boolean|null);
/** Value structValue. */
public structValue?: (google.protobuf.IStruct|null);
/** Value listValue. */
public listValue?: (google.protobuf.IListValue|null);
/** Value kind. */
public kind?: ("nullValue"|"numberValue"|"stringValue"|"boolValue"|"structValue"|"listValue");
/**
* Creates a Value message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Value
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.Value;
/**
* Creates a plain object from a Value message. Also converts values to other types if specified.
* @param message Value
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.Value, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Value to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Value
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** NullValue enum. */
type NullValue =
"NULL_VALUE";
/** Properties of a ListValue. */
interface IListValue {
/** ListValue values */
values?: (google.protobuf.IValue[]|null);
}
/** Represents a ListValue. */
class ListValue implements IListValue {
/**
* Constructs a new ListValue.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IListValue);
/** ListValue values. */
public values: google.protobuf.IValue[];
/**
* Creates a ListValue message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ListValue
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.ListValue;
/**
* Creates a plain object from a ListValue message. Also converts values to other types if specified.
* @param message ListValue
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.ListValue, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ListValue to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ListValue
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a FileDescriptorSet. */
interface IFileDescriptorSet {
/** FileDescriptorSet file */
file?: (google.protobuf.IFileDescriptorProto[]|null);
}
/** Represents a FileDescriptorSet. */
class FileDescriptorSet implements IFileDescriptorSet {
/**
* Constructs a new FileDescriptorSet.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IFileDescriptorSet);
/** FileDescriptorSet file. */
public file: google.protobuf.IFileDescriptorProto[];
/**
* Creates a FileDescriptorSet message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns FileDescriptorSet
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.FileDescriptorSet;
/**
* Creates a plain object from a FileDescriptorSet message. Also converts values to other types if specified.
* @param message FileDescriptorSet
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.FileDescriptorSet, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this FileDescriptorSet to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for FileDescriptorSet
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Edition enum. */
type Edition =
"EDITION_UNKNOWN"| "EDITION_PROTO2"| "EDITION_PROTO3"| "EDITION_2023"| "EDITION_2024"| "EDITION_1_TEST_ONLY"| "EDITION_2_TEST_ONLY"| "EDITION_99997_TEST_ONLY"| "EDITION_99998_TEST_ONLY"| "EDITION_99999_TEST_ONLY"| "EDITION_MAX";
/** Properties of a FileDescriptorProto. */
interface IFileDescriptorProto {
/** FileDescriptorProto name */
name?: (string|null);
/** FileDescriptorProto package */
"package"?: (string|null);
/** FileDescriptorProto dependency */
dependency?: (string[]|null);
/** FileDescriptorProto publicDependency */
publicDependency?: (number[]|null);
/** FileDescriptorProto weakDependency */
weakDependency?: (number[]|null);
/** FileDescriptorProto messageType */
messageType?: (google.protobuf.IDescriptorProto[]|null);
/** FileDescriptorProto enumType */
enumType?: (google.protobuf.IEnumDescriptorProto[]|null);
/** FileDescriptorProto service */
service?: (google.protobuf.IServiceDescriptorProto[]|null);
/** FileDescriptorProto extension */
extension?: (google.protobuf.IFieldDescriptorProto[]|null);
/** FileDescriptorProto options */
options?: (google.protobuf.IFileOptions|null);
/** FileDescriptorProto sourceCodeInfo */
sourceCodeInfo?: (google.protobuf.ISourceCodeInfo|null);
/** FileDescriptorProto syntax */
syntax?: (string|null);
/** FileDescriptorProto edition */
edition?: (google.protobuf.Edition|null);
}
/** Represents a FileDescriptorProto. */
class FileDescriptorProto implements IFileDescriptorProto {
/**
* Constructs a new FileDescriptorProto.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IFileDescriptorProto);
/** FileDescriptorProto name. */
public name: string;
/** FileDescriptorProto package. */
public package: string;
/** FileDescriptorProto dependency. */
public dependency: string[];
/** FileDescriptorProto publicDependency. */
public publicDependency: number[];
/** FileDescriptorProto weakDependency. */
public weakDependency: number[];
/** FileDescriptorProto messageType. */
public messageType: google.protobuf.IDescriptorProto[];
/** FileDescriptorProto enumType. */
public enumType: google.protobuf.IEnumDescriptorProto[];
/** FileDescriptorProto service. */
public service: google.protobuf.IServiceDescriptorProto[];
/** FileDescriptorProto extension. */
public extension: google.protobuf.IFieldDescriptorProto[];
/** FileDescriptorProto options. */
public options?: (google.protobuf.IFileOptions|null);
/** FileDescriptorProto sourceCodeInfo. */
public sourceCodeInfo?: (google.protobuf.ISourceCodeInfo|null);
/** FileDescriptorProto syntax. */
public syntax: string;
/** FileDescriptorProto edition. */
public edition: google.protobuf.Edition;
/**
* Creates a FileDescriptorProto message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns FileDescriptorProto
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.FileDescriptorProto;
/**
* Creates a plain object from a FileDescriptorProto message. Also converts values to other types if specified.
* @param message FileDescriptorProto
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.FileDescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this FileDescriptorProto to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for FileDescriptorProto
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a DescriptorProto. */
interface IDescriptorProto {
/** DescriptorProto name */
name?: (string|null);
/** DescriptorProto field */
field?: (google.protobuf.IFieldDescriptorProto[]|null);
/** DescriptorProto extension */
extension?: (google.protobuf.IFieldDescriptorProto[]|null);
/** DescriptorProto nestedType */
nestedType?: (google.protobuf.IDescriptorProto[]|null);
/** DescriptorProto enumType */
enumType?: (google.protobuf.IEnumDescriptorProto[]|null);
/** DescriptorProto extensionRange */
extensionRange?: (google.protobuf.DescriptorProto.IExtensionRange[]|null);
/** DescriptorProto oneofDecl */
oneofDecl?: (google.protobuf.IOneofDescriptorProto[]|null);
/** DescriptorProto options */
options?: (google.protobuf.IMessageOptions|null);
/** DescriptorProto reservedRange */
reservedRange?: (google.protobuf.DescriptorProto.IReservedRange[]|null);
/** DescriptorProto reservedName */
reservedName?: (string[]|null);
}
/** Represents a DescriptorProto. */
class DescriptorProto implements IDescriptorProto {
/**
* Constructs a new DescriptorProto.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IDescriptorProto);
/** DescriptorProto name. */
public name: string;
/** DescriptorProto field. */
public field: google.protobuf.IFieldDescriptorProto[];
/** DescriptorProto extension. */
public extension: google.protobuf.IFieldDescriptorProto[];
/** DescriptorProto nestedType. */
public nestedType: google.protobuf.IDescriptorProto[];
/** DescriptorProto enumType. */
public enumType: google.protobuf.IEnumDescriptorProto[];
/** DescriptorProto extensionRange. */
public extensionRange: google.protobuf.DescriptorProto.IExtensionRange[];
/** DescriptorProto oneofDecl. */
public oneofDecl: google.protobuf.IOneofDescriptorProto[];
/** DescriptorProto options. */
public options?: (google.protobuf.IMessageOptions|null);
/** DescriptorProto reservedRange. */
public reservedRange: google.protobuf.DescriptorProto.IReservedRange[];
/** DescriptorProto reservedName. */
public reservedName: string[];
/**
* Creates a DescriptorProto message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns DescriptorProto
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.DescriptorProto;
/**
* Creates a plain object from a DescriptorProto message. Also converts values to other types if specified.
* @param message DescriptorProto
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.DescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this DescriptorProto to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for DescriptorProto
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace DescriptorProto {
/** Properties of an ExtensionRange. */
interface IExtensionRange {
/** ExtensionRange start */
start?: (number|null);
/** ExtensionRange end */
end?: (number|null);
/** ExtensionRange options */
options?: (google.protobuf.IExtensionRangeOptions|null);
}
/** Represents an ExtensionRange. */
class ExtensionRange implements IExtensionRange {
/**
* Constructs a new ExtensionRange.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.DescriptorProto.IExtensionRange);
/** ExtensionRange start. */
public start: number;
/** ExtensionRange end. */
public end: number;
/** ExtensionRange options. */
public options?: (google.protobuf.IExtensionRangeOptions|null);
/**
* Creates an ExtensionRange message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ExtensionRange
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.DescriptorProto.ExtensionRange;
/**
* Creates a plain object from an ExtensionRange message. Also converts values to other types if specified.
* @param message ExtensionRange
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.DescriptorProto.ExtensionRange, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ExtensionRange to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ExtensionRange
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ReservedRange. */
interface IReservedRange {
/** ReservedRange start */
start?: (number|null);
/** ReservedRange end */
end?: (number|null);
}
/** Represents a ReservedRange. */
class ReservedRange implements IReservedRange {
/**
* Constructs a new ReservedRange.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.DescriptorProto.IReservedRange);
/** ReservedRange start. */
public start: number;
/** ReservedRange end. */
public end: number;
/**
* Creates a ReservedRange message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ReservedRange
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.DescriptorProto.ReservedRange;
/**
* Creates a plain object from a ReservedRange message. Also converts values to other types if specified.
* @param message ReservedRange
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.DescriptorProto.ReservedRange, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ReservedRange to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ReservedRange
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
}
/** Properties of an ExtensionRangeOptions. */
interface IExtensionRangeOptions {
/** ExtensionRangeOptions uninterpretedOption */
uninterpretedOption?: (google.protobuf.IUninterpretedOption[]|null);
/** ExtensionRangeOptions declaration */
declaration?: (google.protobuf.ExtensionRangeOptions.IDeclaration[]|null);
/** ExtensionRangeOptions features */
features?: (google.protobuf.IFeatureSet|null);
/** ExtensionRangeOptions verification */
verification?: (google.protobuf.ExtensionRangeOptions.VerificationState|null);
}
/** Represents an ExtensionRangeOptions. */
class ExtensionRangeOptions implements IExtensionRangeOptions {
/**
* Constructs a new ExtensionRangeOptions.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IExtensionRangeOptions);
/** ExtensionRangeOptions uninterpretedOption. */
public uninterpretedOption: google.protobuf.IUninterpretedOption[];
/** ExtensionRangeOptions declaration. */
public declaration: google.protobuf.ExtensionRangeOptions.IDeclaration[];
/** ExtensionRangeOptions features. */
public features?: (google.protobuf.IFeatureSet|null);
/** ExtensionRangeOptions verification. */
public verification: google.protobuf.ExtensionRangeOptions.VerificationState;
/**
* Creates an ExtensionRangeOptions message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ExtensionRangeOptions
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.ExtensionRangeOptions;
/**
* Creates a plain object from an ExtensionRangeOptions message. Also converts values to other types if specified.
* @param message ExtensionRangeOptions
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.ExtensionRangeOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ExtensionRangeOptions to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ExtensionRangeOptions
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace ExtensionRangeOptions {
/** Properties of a Declaration. */
interface IDeclaration {
/** Declaration number */
number?: (number|null);
/** Declaration fullName */
fullName?: (string|null);
/** Declaration type */
type?: (string|null);
/** Declaration reserved */
reserved?: (boolean|null);
/** Declaration repeated */
repeated?: (boolean|null);
}
/** Represents a Declaration. */
class Declaration implements IDeclaration {
/**
* Constructs a new Declaration.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.ExtensionRangeOptions.IDeclaration);
/** Declaration number. */
public number: number;
/** Declaration fullName. */
public fullName: string;
/** Declaration type. */
public type: string;
/** Declaration reserved. */
public reserved: boolean;
/** Declaration repeated. */
public repeated: boolean;
/**
* Creates a Declaration message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Declaration
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.ExtensionRangeOptions.Declaration;
/**
* Creates a plain object from a Declaration message. Also converts values to other types if specified.
* @param message Declaration
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.ExtensionRangeOptions.Declaration, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Declaration to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Declaration
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** VerificationState enum. */
type VerificationState =
"DECLARATION"| "UNVERIFIED";
}
/** Properties of a FieldDescriptorProto. */
interface IFieldDescriptorProto {
/** FieldDescriptorProto name */
name?: (string|null);
/** FieldDescriptorProto number */
number?: (number|null);
/** FieldDescriptorProto label */
label?: (google.protobuf.FieldDescriptorProto.Label|null);
/** FieldDescriptorProto type */
type?: (google.protobuf.FieldDescriptorProto.Type|null);
/** FieldDescriptorProto typeName */
typeName?: (string|null);
/** FieldDescriptorProto extendee */
extendee?: (string|null);
/** FieldDescriptorProto defaultValue */
defaultValue?: (string|null);
/** FieldDescriptorProto oneofIndex */
oneofIndex?: (number|null);
/** FieldDescriptorProto jsonName */
jsonName?: (string|null);
/** FieldDescriptorProto options */
options?: (google.protobuf.IFieldOptions|null);
/** FieldDescriptorProto proto3Optional */
proto3Optional?: (boolean|null);
}
/** Represents a FieldDescriptorProto. */
class FieldDescriptorProto implements IFieldDescriptorProto {
/**
* Constructs a new FieldDescriptorProto.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IFieldDescriptorProto);
/** FieldDescriptorProto name. */
public name: string;
/** FieldDescriptorProto number. */
public number: number;
/** FieldDescriptorProto label. */
public label: google.protobuf.FieldDescriptorProto.Label;
/** FieldDescriptorProto type. */
public type: google.protobuf.FieldDescriptorProto.Type;
/** FieldDescriptorProto typeName. */
public typeName: string;
/** FieldDescriptorProto extendee. */
public extendee: string;
/** FieldDescriptorProto defaultValue. */
public defaultValue: string;
/** FieldDescriptorProto oneofIndex. */
public oneofIndex: number;
/** FieldDescriptorProto jsonName. */
public jsonName: string;
/** FieldDescriptorProto options. */
public options?: (google.protobuf.IFieldOptions|null);
/** FieldDescriptorProto proto3Optional. */
public proto3Optional: boolean;
/**
* Creates a FieldDescriptorProto message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns FieldDescriptorProto
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.FieldDescriptorProto;
/**
* Creates a plain object from a FieldDescriptorProto message. Also converts values to other types if specified.
* @param message FieldDescriptorProto
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.FieldDescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this FieldDescriptorProto to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for FieldDescriptorProto
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace FieldDescriptorProto {
/** Type enum. */
type Type =
"TYPE_DOUBLE"| "TYPE_FLOAT"| "TYPE_INT64"| "TYPE_UINT64"| "TYPE_INT32"| "TYPE_FIXED64"| "TYPE_FIXED32"| "TYPE_BOOL"| "TYPE_STRING"| "TYPE_GROUP"| "TYPE_MESSAGE"| "TYPE_BYTES"| "TYPE_UINT32"| "TYPE_ENUM"| "TYPE_SFIXED32"| "TYPE_SFIXED64"| "TYPE_SINT32"| "TYPE_SINT64";
/** Label enum. */
type Label =
"LABEL_OPTIONAL"| "LABEL_REPEATED"| "LABEL_REQUIRED";
}
/** Properties of an OneofDescriptorProto. */
interface IOneofDescriptorProto {
/** OneofDescriptorProto name */
name?: (string|null);
/** OneofDescriptorProto options */
options?: (google.protobuf.IOneofOptions|null);
}
/** Represents an OneofDescriptorProto. */
class OneofDescriptorProto implements IOneofDescriptorProto {
/**
* Constructs a new OneofDescriptorProto.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IOneofDescriptorProto);
/** OneofDescriptorProto name. */
public name: string;
/** OneofDescriptorProto options. */
public options?: (google.protobuf.IOneofOptions|null);
/**
* Creates an OneofDescriptorProto message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns OneofDescriptorProto
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.OneofDescriptorProto;
/**
* Creates a plain object from an OneofDescriptorProto message. Also converts values to other types if specified.
* @param message OneofDescriptorProto
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.OneofDescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this OneofDescriptorProto to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for OneofDescriptorProto
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an EnumDescriptorProto. */
interface IEnumDescriptorProto {
/** EnumDescriptorProto name */
name?: (string|null);
/** EnumDescriptorProto value */
value?: (google.protobuf.IEnumValueDescriptorProto[]|null);
/** EnumDescriptorProto options */
options?: (google.protobuf.IEnumOptions|null);
/** EnumDescriptorProto reservedRange */
reservedRange?: (google.protobuf.EnumDescriptorProto.IEnumReservedRange[]|null);
/** EnumDescriptorProto reservedName */
reservedName?: (string[]|null);
}
/** Represents an EnumDescriptorProto. */
class EnumDescriptorProto implements IEnumDescriptorProto {
/**
* Constructs a new EnumDescriptorProto.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IEnumDescriptorProto);
/** EnumDescriptorProto name. */
public name: string;
/** EnumDescriptorProto value. */
public value: google.protobuf.IEnumValueDescriptorProto[];
/** EnumDescriptorProto options. */
public options?: (google.protobuf.IEnumOptions|null);
/** EnumDescriptorProto reservedRange. */
public reservedRange: google.protobuf.EnumDescriptorProto.IEnumReservedRange[];
/** EnumDescriptorProto reservedName. */
public reservedName: string[];
/**
* Creates an EnumDescriptorProto message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns EnumDescriptorProto
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.EnumDescriptorProto;
/**
* Creates a plain object from an EnumDescriptorProto message. Also converts values to other types if specified.
* @param message EnumDescriptorProto
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.EnumDescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this EnumDescriptorProto to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for EnumDescriptorProto
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace EnumDescriptorProto {
/** Properties of an EnumReservedRange. */
interface IEnumReservedRange {
/** EnumReservedRange start */
start?: (number|null);
/** EnumReservedRange end */
end?: (number|null);
}
/** Represents an EnumReservedRange. */
class EnumReservedRange implements IEnumReservedRange {
/**
* Constructs a new EnumReservedRange.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.EnumDescriptorProto.IEnumReservedRange);
/** EnumReservedRange start. */
public start: number;
/** EnumReservedRange end. */
public end: number;
/**
* Creates an EnumReservedRange message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns EnumReservedRange
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.EnumDescriptorProto.EnumReservedRange;
/**
* Creates a plain object from an EnumReservedRange message. Also converts values to other types if specified.
* @param message EnumReservedRange
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.EnumDescriptorProto.EnumReservedRange, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this EnumReservedRange to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for EnumReservedRange
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
}
/** Properties of an EnumValueDescriptorProto. */
interface IEnumValueDescriptorProto {
/** EnumValueDescriptorProto name */
name?: (string|null);
/** EnumValueDescriptorProto number */
number?: (number|null);
/** EnumValueDescriptorProto options */
options?: (google.protobuf.IEnumValueOptions|null);
}
/** Represents an EnumValueDescriptorProto. */
class EnumValueDescriptorProto implements IEnumValueDescriptorProto {
/**
* Constructs a new EnumValueDescriptorProto.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IEnumValueDescriptorProto);
/** EnumValueDescriptorProto name. */
public name: string;
/** EnumValueDescriptorProto number. */
public number: number;
/** EnumValueDescriptorProto options. */
public options?: (google.protobuf.IEnumValueOptions|null);
/**
* Creates an EnumValueDescriptorProto message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns EnumValueDescriptorProto
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.EnumValueDescriptorProto;
/**
* Creates a plain object from an EnumValueDescriptorProto message. Also converts values to other types if specified.
* @param message EnumValueDescriptorProto
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.EnumValueDescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this EnumValueDescriptorProto to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for EnumValueDescriptorProto
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ServiceDescriptorProto. */
interface IServiceDescriptorProto {
/** ServiceDescriptorProto name */
name?: (string|null);
/** ServiceDescriptorProto method */
method?: (google.protobuf.IMethodDescriptorProto[]|null);
/** ServiceDescriptorProto options */
options?: (google.protobuf.IServiceOptions|null);
}
/** Represents a ServiceDescriptorProto. */
class ServiceDescriptorProto implements IServiceDescriptorProto {
/**
* Constructs a new ServiceDescriptorProto.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IServiceDescriptorProto);
/** ServiceDescriptorProto name. */
public name: string;
/** ServiceDescriptorProto method. */
public method: google.protobuf.IMethodDescriptorProto[];
/** ServiceDescriptorProto options. */
public options?: (google.protobuf.IServiceOptions|null);
/**
* Creates a ServiceDescriptorProto message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ServiceDescriptorProto
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.ServiceDescriptorProto;
/**
* Creates a plain object from a ServiceDescriptorProto message. Also converts values to other types if specified.
* @param message ServiceDescriptorProto
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.ServiceDescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ServiceDescriptorProto to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ServiceDescriptorProto
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a MethodDescriptorProto. */
interface IMethodDescriptorProto {
/** MethodDescriptorProto name */
name?: (string|null);
/** MethodDescriptorProto inputType */
inputType?: (string|null);
/** MethodDescriptorProto outputType */
outputType?: (string|null);
/** MethodDescriptorProto options */
options?: (google.protobuf.IMethodOptions|null);
/** MethodDescriptorProto clientStreaming */
clientStreaming?: (boolean|null);
/** MethodDescriptorProto serverStreaming */
serverStreaming?: (boolean|null);
}
/** Represents a MethodDescriptorProto. */
class MethodDescriptorProto implements IMethodDescriptorProto {
/**
* Constructs a new MethodDescriptorProto.
* @param [properties] Properties to set
*/
constructor(properties?: google.protobuf.IMethodDescriptorProto);
/** MethodDescriptorProto name. */
public name: string;
/** MethodDescriptorProto inputType. */
public inputType: string;
/** MethodDescriptorProto outputType. */
public outputType: string;
/** MethodDescriptorProto options. */
public options?: (google.protobuf.IMethodOptions|null);
/** MethodDescriptorProto clientStreaming. */
public clientStreaming: boolean;
/** MethodDescriptorProto serverStreaming. */
public serverStreaming: boolean;
/**
* Creates a MethodDescriptorProto message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns MethodDescriptorProto
*/
public static fromObject(object: { [k: string]: any }): google.protobuf.MethodDescriptorProto;
/**
* Creates a plain object from a MethodDescriptorProto message. Also converts values to other types if specified.
* @param message MethodDescriptorProto
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.protobuf.MethodDescriptorProto, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this MethodDescriptorProto to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for MethodDescriptorProto
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a FileOptions. */
interface IFileOptions {
/** FileOptions javaPackage */
javaPackage?: (string|null);
/** FileOptions javaOuterClassname */
javaOuterClassname?: (string|null);
/** FileOptions javaMultipleFiles */
javaMultipleFiles?: (boolean|null);
/** FileOptions javaGenerateEqualsAndHash */
javaGenerateEqualsAndHash?: (boolean|null);
/** FileOptions javaStringCheckUtf8 */
javaStringCheckUtf8?: (boolean|null);
/** FileOptions optimizeFor */
optimizeFor?: (google.protobuf.FileOptions.OptimizeMode|null);
/** FileOptions goPackage */
goPackage?: (s