Class protos.google.cloud.automl.v1.Dataset (2.4.5)

Version 2.4.5

• 4.0.1 (latest)
• 4.0.0
• 3.1.2
• 2.5.2
• 2.4.5

Represents a Dataset.

Package

@google-cloud/automl!

Constructors

(constructor)(properties)

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

Constructs a new Dataset.

Parameter

Name	Description
properties	IDataset Properties to set

Properties

createTime

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

Dataset createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

datasetMetadata

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

Dataset datasetMetadata.

Property Value

Type	Description
("translationDatasetMetadata"|"imageClassificationDatasetMetadata"|"textClassificationDatasetMetadata"|"imageObjectDetectionDatasetMetadata"|"textExtractionDatasetMetadata"|"textSentimentDatasetMetadata")

description

public description: string;

Dataset description.

Property Value

Type	Description
string

displayName

public displayName: string;

Dataset displayName.

Property Value

Type	Description
string

etag

public etag: string;

Dataset etag.

Property Value

Type	Description
string

exampleCount

public exampleCount: number;

Dataset exampleCount.

Property Value

Type	Description
number

imageClassificationDatasetMetadata

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

Dataset imageClassificationDatasetMetadata.

Property Value

Type	Description
(google.cloud.automl.v1.IImageClassificationDatasetMetadata|null)

imageObjectDetectionDatasetMetadata

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

Dataset imageObjectDetectionDatasetMetadata.

Property Value

Type	Description
(google.cloud.automl.v1.IImageObjectDetectionDatasetMetadata|null)

labels

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

Dataset labels.

Property Value

Type	Description
{ [k: string]: string }

name

public name: string;

Dataset name.

Property Value

Type	Description
string

textClassificationDatasetMetadata

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

Dataset textClassificationDatasetMetadata.

Property Value

Type	Description
(google.cloud.automl.v1.ITextClassificationDatasetMetadata|null)

textExtractionDatasetMetadata

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

Dataset textExtractionDatasetMetadata.

Property Value

Type	Description
(google.cloud.automl.v1.ITextExtractionDatasetMetadata|null)

textSentimentDatasetMetadata

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

Dataset textSentimentDatasetMetadata.

Property Value

Type	Description
(google.cloud.automl.v1.ITextSentimentDatasetMetadata|null)

translationDatasetMetadata

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

Dataset translationDatasetMetadata.

Property Value

Type	Description
(google.cloud.automl.v1.ITranslationDatasetMetadata|null)

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

Name	Description
properties	IDataset Properties to set

Returns

Type	Description
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

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
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

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
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

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.automl.v1.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.automl.v1.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
google.cloud.automl.v1.Dataset	Dataset

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

Name	Description
message	google.cloud.automl.v1.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)	null if valid, otherwise the reason why it is not