Class protos.google.cloud.aiplatform.v1beta1.NearestNeighbors.Neighbor (3.13.0)

Represents a Neighbor.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.NearestNeighbors.INeighbor);

Constructs a new Neighbor.

Parameter
NameDescription
properties INeighbor

Properties to set

Properties

distance

public distance: number;

Neighbor distance.

entityId

public entityId: string;

Neighbor entityId.

entityKeyValues

public entityKeyValues?: (google.cloud.aiplatform.v1beta1.IFetchFeatureValuesResponse|null);

Neighbor entityKeyValues.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.NearestNeighbors.INeighbor): google.cloud.aiplatform.v1beta1.NearestNeighbors.Neighbor;

Creates a new Neighbor instance using the specified properties.

Parameter
NameDescription
properties INeighbor

Properties to set

Returns
TypeDescription
Neighbor

Neighbor instance

decode(reader, length)

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

Decodes a Neighbor message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Neighbor

Neighbor

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.NearestNeighbors.Neighbor;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Neighbor

Neighbor

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1beta1.NearestNeighbors.INeighbor, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Neighbor message. Does not implicitly messages.

Parameters
NameDescription
message INeighbor

Neighbor 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.v1beta1.NearestNeighbors.INeighbor, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message INeighbor

Neighbor 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.v1beta1.NearestNeighbors.Neighbor;

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

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

Plain object

Returns
TypeDescription
Neighbor

Neighbor

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Neighbor

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 Neighbor to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Neighbor

Neighbor

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