Class protos.google.cloud.automl.v1.Dataset

Represents a Dataset.

Package

@google-cloud/automl

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.automl.v1.IDataset);

Constructs a new Dataset.

Parameter
NameDescription
properties IDataset

Properties to set

Properties

createTime

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

Dataset createTime.

datasetMetadata

public datasetMetadata?: ("translationDatasetMetadata"|"imageClassificationDatasetMetadata"|"textClassificationDatasetMetadata"|"imageObjectDetectionDatasetMetadata"|"textExtractionDatasetMetadata"|"textSentimentDatasetMetadata");

Dataset datasetMetadata.

description

public description: string;

Dataset description.

displayName

public displayName: string;

Dataset displayName.

etag

public etag: string;

Dataset etag.

exampleCount

public exampleCount: number;

Dataset exampleCount.

imageClassificationDatasetMetadata

public imageClassificationDatasetMetadata?: (google.cloud.automl.v1.IImageClassificationDatasetMetadata|null);

Dataset imageClassificationDatasetMetadata.

imageObjectDetectionDatasetMetadata

public imageObjectDetectionDatasetMetadata?: (google.cloud.automl.v1.IImageObjectDetectionDatasetMetadata|null);

Dataset imageObjectDetectionDatasetMetadata.

labels

public labels: { [k: string]: string };

Dataset labels.

name

public name: string;

Dataset name.

textClassificationDatasetMetadata

public textClassificationDatasetMetadata?: (google.cloud.automl.v1.ITextClassificationDatasetMetadata|null);

Dataset textClassificationDatasetMetadata.

textExtractionDatasetMetadata

public textExtractionDatasetMetadata?: (google.cloud.automl.v1.ITextExtractionDatasetMetadata|null);

Dataset textExtractionDatasetMetadata.

textSentimentDatasetMetadata

public textSentimentDatasetMetadata?: (google.cloud.automl.v1.ITextSentimentDatasetMetadata|null);

Dataset textSentimentDatasetMetadata.

translationDatasetMetadata

public translationDatasetMetadata?: (google.cloud.automl.v1.ITranslationDatasetMetadata|null);

Dataset translationDatasetMetadata.

Methods

create(properties)

public static create(properties?: google.cloud.automl.v1.IDataset): google.cloud.automl.v1.Dataset;

Creates a new Dataset instance using the specified properties.

Parameter
NameDescription
properties IDataset

Properties to set

Returns
TypeDescription
google.cloud.automl.v1.Dataset

Dataset instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.automl.v1.Dataset;

Decodes a Dataset message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.automl.v1.Dataset

Dataset

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.automl.v1.Dataset;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.automl.v1.Dataset

Dataset

encode(message, writer)

public static encode(message: google.cloud.automl.v1.IDataset, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Dataset message. Does not implicitly messages.

Parameters
NameDescription
message IDataset

Dataset message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.automl.v1.IDataset, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDataset

Dataset message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.automl.v1.Dataset;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.automl.v1.Dataset

Dataset

toJSON()

public toJSON(): { [k: string]: any };

Converts this Dataset to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.automl.v1.Dataset, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.automl.v1.Dataset

Dataset

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Dataset message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not