Class protos.google.cloud.aiplatform.v1beta1.SearchNearestEntitiesRequest (3.7.0)

Represents a SearchNearestEntitiesRequest.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new SearchNearestEntitiesRequest.

Parameter
NameDescription
properties ISearchNearestEntitiesRequest

Properties to set

Properties

featureView

public featureView: string;

SearchNearestEntitiesRequest featureView.

query

public query?: (google.cloud.aiplatform.v1beta1.INearestNeighborQuery|null);

SearchNearestEntitiesRequest query.

returnFullEntity

public returnFullEntity: boolean;

SearchNearestEntitiesRequest returnFullEntity.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.ISearchNearestEntitiesRequest): google.cloud.aiplatform.v1beta1.SearchNearestEntitiesRequest;

Creates a new SearchNearestEntitiesRequest instance using the specified properties.

Parameter
NameDescription
properties ISearchNearestEntitiesRequest

Properties to set

Returns
TypeDescription
SearchNearestEntitiesRequest

SearchNearestEntitiesRequest instance

decode(reader, length)

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

Decodes a SearchNearestEntitiesRequest 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
SearchNearestEntitiesRequest

SearchNearestEntitiesRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SearchNearestEntitiesRequest

SearchNearestEntitiesRequest

encode(message, writer)

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

Encodes the specified SearchNearestEntitiesRequest message. Does not implicitly messages.

Parameters
NameDescription
message ISearchNearestEntitiesRequest

SearchNearestEntitiesRequest 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.ISearchNearestEntitiesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISearchNearestEntitiesRequest

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

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

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

Plain object

Returns
TypeDescription
SearchNearestEntitiesRequest

SearchNearestEntitiesRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SearchNearestEntitiesRequest

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message SearchNearestEntitiesRequest

SearchNearestEntitiesRequest

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