Represents a Dataset.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.cloud.documentai.v1beta3.IDataset);Constructs a new Dataset.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataset
Properties to set |
Properties
documentWarehouseConfig
public documentWarehouseConfig?: (google.cloud.documentai.v1beta3.Dataset.IDocumentWarehouseConfig|null);Dataset documentWarehouseConfig.
gcsManagedConfig
public gcsManagedConfig?: (google.cloud.documentai.v1beta3.Dataset.IGCSManagedConfig|null);Dataset gcsManagedConfig.
indexingSource
public indexingSource?: "spannerIndexingConfig";Dataset indexingSource.
name
public name: string;Dataset name.
spannerIndexingConfig
public spannerIndexingConfig?: (google.cloud.documentai.v1beta3.Dataset.ISpannerIndexingConfig|null);Dataset spannerIndexingConfig.
state
public state: (google.cloud.documentai.v1beta3.Dataset.State|keyof typeof google.cloud.documentai.v1beta3.Dataset.State);Dataset state.
storageSource
public storageSource?: ("gcsManagedConfig"|"documentWarehouseConfig"|"unmanagedDatasetConfig");Dataset storageSource.
unmanagedDatasetConfig
public unmanagedDatasetConfig?: (google.cloud.documentai.v1beta3.Dataset.IUnmanagedDatasetConfig|null);Dataset unmanagedDatasetConfig.
Methods
create(properties)
public static create(properties?: google.cloud.documentai.v1beta3.IDataset): google.cloud.documentai.v1beta3.Dataset;Creates a new Dataset instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataset
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Dataset | Dataset instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.Dataset;Decodes a Dataset 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 |
Dataset | Dataset |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.Dataset;Decodes a Dataset message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Dataset | Dataset |
encode(message, writer)
public static encode(message: google.cloud.documentai.v1beta3.IDataset, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Dataset message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataset
Dataset 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.documentai.v1beta3.IDataset, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Dataset message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataset
Dataset 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.documentai.v1beta3.Dataset;Creates a Dataset 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 |
Dataset | Dataset |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Dataset
| 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 Dataset to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.documentai.v1beta3.Dataset, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Dataset message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Dataset
Dataset |
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 Dataset message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|