Represents an Index.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1.IIndex);Constructs a new Index.
| Parameter | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Name | Description |
properties |
IIndex
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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.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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
IIndex
Index 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.IIndex, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Index message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IIndex
Index 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.Index;Creates an Index 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.Index | Index |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Index
| 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 Index to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
google.cloud.aiplatform.v1.Index
Index |
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 an Index message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|