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