Class protos.google.cloud.aiplatform.v1.Dataset (2.5.0)

Represents a Dataset.

Package

Constructors

(constructor)(properties)

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

Constructs a new Dataset.

Parameter

Name	Description
`properties`	`IDataset` Properties to set

Properties

createTime

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

Dataset createTime.

description

public description: string;

Dataset description.

displayName

public displayName: string;

Dataset displayName.

encryptionSpec

public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);

Dataset encryptionSpec.

etag

public etag: string;

Dataset etag.

labels

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

Dataset labels.

metadata

public metadata?: (google.protobuf.IValue|null);

Dataset metadata.

metadataArtifact

public metadataArtifact: string;

Dataset metadataArtifact.

metadataSchemaUri

public metadataSchemaUri: string;

Dataset metadataSchemaUri.

name

public name: string;

Dataset name.

savedQueries

public savedQueries: google.cloud.aiplatform.v1.ISavedQuery[];

Dataset savedQueries.

updateTime

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

Dataset updateTime.

Methods

create(properties)

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

Creates a new Dataset instance using the specified properties.

Parameter

Name	Description
`properties`	`IDataset` Properties to set

Returns

Type	Description
`google.cloud.aiplatform.v1.Dataset`	Dataset instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.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.aiplatform.v1.Dataset`	Dataset

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.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.aiplatform.v1.Dataset`	Dataset

encode(message, writer)

public static encode(message: google.cloud.aiplatform.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.aiplatform.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.aiplatform.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.aiplatform.v1.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.aiplatform.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.aiplatform.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