Class protos.google.cloud.aiplatform.v1.Index (2.10.0)

Represents an Index.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new Index.

Parameter
NameDescription
properties IIndex

Properties to set

Properties

createTime

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

Index createTime.

deployedIndexes

public deployedIndexes: google.cloud.aiplatform.v1.IDeployedIndexRef[];

Index deployedIndexes.

description

public description: string;

Index description.

displayName

public displayName: string;

Index displayName.

etag

public etag: string;

Index etag.

indexStats

public indexStats?: (google.cloud.aiplatform.v1.IIndexStats|null);

Index indexStats.

indexUpdateMethod

public indexUpdateMethod: (google.cloud.aiplatform.v1.Index.IndexUpdateMethod|keyof typeof google.cloud.aiplatform.v1.Index.IndexUpdateMethod);

Index indexUpdateMethod.

labels

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

Index labels.

metadata

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

Index metadata.

metadataSchemaUri

public metadataSchemaUri: string;

Index metadataSchemaUri.

name

public name: string;

Index name.

updateTime

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

Index updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IIndex): google.cloud.aiplatform.v1.Index;

Creates a new Index instance using the specified properties.

Parameter
NameDescription
properties IIndex

Properties to set

Returns
TypeDescription
google.cloud.aiplatform.v1.Index

Index instance

decode(reader, length)

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

Decodes an Index 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.aiplatform.v1.Index

Index

decodeDelimited(reader)

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

Decodes an Index 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.aiplatform.v1.Index

Index

encode(message, writer)

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

Encodes the specified Index message. Does not implicitly messages.

Parameters
NameDescription
message IIndex

Index 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.aiplatform.v1.IIndex, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IIndex

Index 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.aiplatform.v1.Index;

Creates an Index 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.aiplatform.v1.Index

Index

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Index

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Index to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.aiplatform.v1.Index

Index

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Index 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