DocumentId

google.cloud.documentai.v1beta3. DocumentId

Represents a DocumentId.

Constructor

new DocumentId(propertiesopt)

Constructs a new DocumentId.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta3.IDocumentId <optional>

Properties to set

Implements:
  • IDocumentId

Classes

GCSManagedDocumentId
UnmanagedDocumentId

Members

gcsManagedDocId

DocumentId gcsManagedDocId.

revisionRef

DocumentId revisionRef.

type

DocumentId type.

unmanagedDocId

DocumentId unmanagedDocId.

Methods

toJSON() → {Object.<string, *>}

Converts this DocumentId to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.documentai.v1beta3.DocumentId}

Creates a new DocumentId instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta3.IDocumentId <optional>

Properties to set

Returns:
Type Description
google.cloud.documentai.v1beta3.DocumentId

DocumentId instance

(static) decode(reader, lengthopt) → {google.cloud.documentai.v1beta3.DocumentId}

Decodes a DocumentId message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.documentai.v1beta3.DocumentId

DocumentId

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.documentai.v1beta3.DocumentId}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.documentai.v1beta3.DocumentId

DocumentId

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified DocumentId message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.IDocumentId

DocumentId message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.IDocumentId

DocumentId message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.documentai.v1beta3.DocumentId}

Creates a DocumentId message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.documentai.v1beta3.DocumentId

DocumentId

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for DocumentId

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.DocumentId

DocumentId

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a DocumentId message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not