RevisionRef

google.cloud.documentai.v1beta3. RevisionRef

Represents a RevisionRef.

Constructor

new RevisionRef(propertiesopt)

Constructs a new RevisionRef.

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

Properties to set

Implements:
  • IRevisionRef

Members

latestProcessorVersion

RevisionRef latestProcessorVersion.

revisionCase

RevisionRef revisionCase.

revisionId

RevisionRef revisionId.

source

RevisionRef source.

RevisionCase

RevisionCase enum.

Properties:
Name Type Description
REVISION_CASE_UNSPECIFIED number

REVISION_CASE_UNSPECIFIED value

LATEST_HUMAN_REVIEW number

LATEST_HUMAN_REVIEW value

LATEST_TIMESTAMP number

LATEST_TIMESTAMP value

BASE_OCR_REVISION number

BASE_OCR_REVISION value

Methods

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

Converts this RevisionRef to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new RevisionRef instance using the specified properties.

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

Properties to set

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

RevisionRef instance

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

Decodes a RevisionRef 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.RevisionRef

RevisionRef

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.RevisionRef}

Decodes a RevisionRef 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.RevisionRef

RevisionRef

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 RevisionRef message. Does not implicitly verify messages.

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

RevisionRef 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 RevisionRef message, length delimited. Does not implicitly verify messages.

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

RevisionRef 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.RevisionRef}

Creates a RevisionRef 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.RevisionRef

RevisionRef

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for RevisionRef

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 RevisionRef message. Also converts values to other types if specified.

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

RevisionRef

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a RevisionRef 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