Dataset

google.cloud.documentai.v1beta3. Dataset

Represents a Dataset.

Constructor

new Dataset(propertiesopt)

Constructs a new Dataset.

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

Properties to set

Implements:
  • IDataset

Classes

DocumentWarehouseConfig
GCSManagedConfig
SpannerIndexingConfig
UnmanagedDatasetConfig

Members

documentWarehouseConfig

Dataset documentWarehouseConfig.

gcsManagedConfig

Dataset gcsManagedConfig.

indexingSource

Dataset indexingSource.

name

Dataset name.

satisfiesPzi

Dataset satisfiesPzi.

satisfiesPzs

Dataset satisfiesPzs.

spannerIndexingConfig

Dataset spannerIndexingConfig.

state

Dataset state.

storageSource

Dataset storageSource.

unmanagedDatasetConfig

Dataset unmanagedDatasetConfig.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

UNINITIALIZED number

UNINITIALIZED value

INITIALIZING number

INITIALIZING value

INITIALIZED number

INITIALIZED value

Methods

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

Converts this Dataset to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Dataset instance using the specified properties.

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

Properties to set

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

Dataset instance

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

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

Dataset

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

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

Dataset

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

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

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

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

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

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

Dataset

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Dataset

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

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

Dataset

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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