Class protos.google.cloud.aiplatform.v1.IndexEndpoint (3.11.0)

Represents an IndexEndpoint.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new IndexEndpoint.

Parameter
NameDescription
properties IIndexEndpoint

Properties to set

Properties

createTime

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

IndexEndpoint createTime.

deployedIndexes

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

IndexEndpoint deployedIndexes.

description

public description: string;

IndexEndpoint description.

displayName

public displayName: string;

IndexEndpoint displayName.

enablePrivateServiceConnect

public enablePrivateServiceConnect: boolean;

IndexEndpoint enablePrivateServiceConnect.

encryptionSpec

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

IndexEndpoint encryptionSpec.

etag

public etag: string;

IndexEndpoint etag.

labels

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

IndexEndpoint labels.

name

public name: string;

IndexEndpoint name.

network

public network: string;

IndexEndpoint network.

privateServiceConnectConfig

public privateServiceConnectConfig?: (google.cloud.aiplatform.v1.IPrivateServiceConnectConfig|null);

IndexEndpoint privateServiceConnectConfig.

publicEndpointDomainName

public publicEndpointDomainName: string;

IndexEndpoint publicEndpointDomainName.

publicEndpointEnabled

public publicEndpointEnabled: boolean;

IndexEndpoint publicEndpointEnabled.

updateTime

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

IndexEndpoint updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IIndexEndpoint): google.cloud.aiplatform.v1.IndexEndpoint;

Creates a new IndexEndpoint instance using the specified properties.

Parameter
NameDescription
properties IIndexEndpoint

Properties to set

Returns
TypeDescription
IndexEndpoint

IndexEndpoint instance

decode(reader, length)

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

Decodes an IndexEndpoint 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
IndexEndpoint

IndexEndpoint

decodeDelimited(reader)

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

Decodes an IndexEndpoint message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
IndexEndpoint

IndexEndpoint

encode(message, writer)

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

Encodes the specified IndexEndpoint message. Does not implicitly messages.

Parameters
NameDescription
message IIndexEndpoint

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

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

Parameters
NameDescription
message IIndexEndpoint

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

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

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

Plain object

Returns
TypeDescription
IndexEndpoint

IndexEndpoint

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for IndexEndpoint

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message IndexEndpoint

IndexEndpoint

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