Class protos.google.cloud.contentwarehouse.v1.Document (1.7.0)

Represents a Document.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.contentwarehouse.v1.IDocument);

Constructs a new Document.

Parameter
Name	Description
`properties`	`IDocument` Properties to set

Properties

asyncEnabled

public asyncEnabled: boolean;

Document asyncEnabled.

cloudAiDocument

public cloudAiDocument?: (google.cloud.documentai.v1.IDocument|null);

Document cloudAiDocument.

contentCategory

public contentCategory: (google.cloud.contentwarehouse.v1.ContentCategory|keyof typeof google.cloud.contentwarehouse.v1.ContentCategory);

Document contentCategory.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Document createTime.

creator

public creator: string;

Document creator.

displayName

public displayName: string;

Document displayName.

displayUri

public displayUri: string;

Document displayUri.

dispositionTime

public dispositionTime?: (google.protobuf.ITimestamp|null);

Document dispositionTime.

documentSchemaName

public documentSchemaName: string;

Document documentSchemaName.

inlineRawDocument

public inlineRawDocument?: (Uint8Array|string|null);

Document inlineRawDocument.

legalHold

public legalHold: boolean;

Document legalHold.

name

public name: string;

Document name.

plainText

public plainText?: (string|null);

Document plainText.

properties

public properties: google.cloud.contentwarehouse.v1.IProperty[];

Document properties.

rawDocument

public rawDocument?: ("rawDocumentPath"|"inlineRawDocument");

Document rawDocument.

rawDocumentFileType

public rawDocumentFileType: (google.cloud.contentwarehouse.v1.RawDocumentFileType|keyof typeof google.cloud.contentwarehouse.v1.RawDocumentFileType);

Document rawDocumentFileType.

rawDocumentPath

public rawDocumentPath?: (string|null);

Document rawDocumentPath.

referenceId

public referenceId: string;

Document referenceId.

structuredContent

public structuredContent?: ("plainText"|"cloudAiDocument");

Document structuredContent.

structuredContentUri

public structuredContentUri: string;

Document structuredContentUri.

textExtractionDisabled

public textExtractionDisabled: boolean;

Document textExtractionDisabled.

textExtractionEnabled

public textExtractionEnabled: boolean;

Document textExtractionEnabled.

title

public title: string;

Document title.

updater

public updater: string;

Document updater.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Document updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.contentwarehouse.v1.IDocument): google.cloud.contentwarehouse.v1.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.contentwarehouse.v1.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.contentwarehouse.v1.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.contentwarehouse.v1.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.contentwarehouse.v1.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.contentwarehouse.v1.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.contentwarehouse.v1.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