Class protos.google.cloud.dialogflow.v2beta1.Document (7.1.0)

Represents a Document.

Package

@google-cloud/dialogflow

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.v2beta1.IDocument);

Constructs a new Document.

Parameter
Name Description
properties IDocument

Properties to set

Properties

content

public content?: (string|null);

Document content.

contentUri

public contentUri?: (string|null);

Document contentUri.

displayName

public displayName: string;

Document displayName.

enableAutoReload

public enableAutoReload: boolean;

Document enableAutoReload.

knowledgeTypes

public knowledgeTypes: google.cloud.dialogflow.v2beta1.Document.KnowledgeType[];

Document knowledgeTypes.

latestReloadStatus

public latestReloadStatus?: (google.cloud.dialogflow.v2beta1.Document.IReloadStatus|null);

Document latestReloadStatus.

metadata

public metadata: { [k: string]: string };

Document metadata.

mimeType

public mimeType: string;

Document mimeType.

name

public name: string;

Document name.

rawContent

public rawContent?: (Uint8Array|Buffer|string|null);

Document rawContent.

source

public source?: ("contentUri"|"content"|"rawContent");

Document source.

state

public state: (google.cloud.dialogflow.v2beta1.Document.State|keyof typeof google.cloud.dialogflow.v2beta1.Document.State);

Document state.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.v2beta1.IDocument): google.cloud.dialogflow.v2beta1.Document;

Creates a new Document instance using the specified properties.

Parameter
Name Description
properties IDocument

Properties to set
Returns
Type Description
Document

Document instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.v2beta1.Document;

Decodes a Document 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
Document

Document

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.v2beta1.Document;

Decodes a Document message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
Document

Document

encode(message, writer)

public static encode(message: google.cloud.dialogflow.v2beta1.IDocument, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Document message. Does not implicitly messages.

Parameters
Name Description
message IDocument

Document 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.cloud.dialogflow.v2beta1.IDocument, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Document message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IDocument

Document 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.cloud.dialogflow.v2beta1.Document;

Creates a Document 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
Document

Document

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Document

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 Document to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.v2beta1.Document, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Document message. Also converts values to other types if specified.

Parameters
Name Description
message Document

Document
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 Document message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not