Represents a FileOptions.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.protobuf.IFileOptions);Constructs a new FileOptions.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFileOptions
Properties to set |
Properties
ccEnableArenas
public ccEnableArenas: boolean;FileOptions ccEnableArenas.
ccGenericServices
public ccGenericServices: boolean;FileOptions ccGenericServices.
csharpNamespace
public csharpNamespace: string;FileOptions csharpNamespace.
deprecated
public deprecated: boolean;FileOptions deprecated.
goPackage
public goPackage: string;FileOptions goPackage.
javaGenerateEqualsAndHash
public javaGenerateEqualsAndHash: boolean;FileOptions javaGenerateEqualsAndHash.
javaGenericServices
public javaGenericServices: boolean;FileOptions javaGenericServices.
javaMultipleFiles
public javaMultipleFiles: boolean;FileOptions javaMultipleFiles.
javaOuterClassname
public javaOuterClassname: string;FileOptions javaOuterClassname.
javaPackage
public javaPackage: string;FileOptions javaPackage.
javaStringCheckUtf8
public javaStringCheckUtf8: boolean;FileOptions javaStringCheckUtf8.
objcClassPrefix
public objcClassPrefix: string;FileOptions objcClassPrefix.
optimizeFor
public optimizeFor: (google.protobuf.FileOptions.OptimizeMode|keyof typeof google.protobuf.FileOptions.OptimizeMode);FileOptions optimizeFor.
phpClassPrefix
public phpClassPrefix: string;FileOptions phpClassPrefix.
phpGenericServices
public phpGenericServices: boolean;FileOptions phpGenericServices.
phpMetadataNamespace
public phpMetadataNamespace: string;FileOptions phpMetadataNamespace.
phpNamespace
public phpNamespace: string;FileOptions phpNamespace.
pyGenericServices
public pyGenericServices: boolean;FileOptions pyGenericServices.
rubyPackage
public rubyPackage: string;FileOptions rubyPackage.
swiftPrefix
public swiftPrefix: string;FileOptions swiftPrefix.
uninterpretedOption
public uninterpretedOption: google.protobuf.IUninterpretedOption[];FileOptions uninterpretedOption.
Methods
create(properties)
public static create(properties?: google.protobuf.IFileOptions): google.protobuf.FileOptions;Creates a new FileOptions instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFileOptions
Properties to set |
| Returns | |
|---|---|
| Type | Description |
FileOptions | FileOptions instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.FileOptions;Decodes a FileOptions 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 |
FileOptions | FileOptions |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.FileOptions;Decodes a FileOptions message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
FileOptions | FileOptions |
encode(message, writer)
public static encode(message: google.protobuf.IFileOptions, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified FileOptions message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFileOptions
FileOptions 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.protobuf.IFileOptions, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified FileOptions message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFileOptions
FileOptions 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.protobuf.FileOptions;Creates a FileOptions 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 |
FileOptions | FileOptions |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for FileOptions
| 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 FileOptions to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.protobuf.FileOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a FileOptions message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
FileOptions
FileOptions |
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 FileOptions message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|