Class protos.google.cloud.aiplatform.v1.DeployedIndex (1.15.0)

Represents a DeployedIndex.

Package

Constructors

(constructor)(properties)

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

Constructs a new DeployedIndex.

Parameter

Name	Description
properties	`IDeployedIndex` Properties to set

Properties

automaticResources

public automaticResources?: (google.cloud.aiplatform.v1.IAutomaticResources|null);

DeployedIndex automaticResources.

createTime

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

DeployedIndex createTime.

dedicatedResources

public dedicatedResources?: (google.cloud.aiplatform.v1.IDedicatedResources|null);

DeployedIndex dedicatedResources.

deployedIndexAuthConfig

public deployedIndexAuthConfig?: (google.cloud.aiplatform.v1.IDeployedIndexAuthConfig|null);

DeployedIndex deployedIndexAuthConfig.

deploymentGroup

public deploymentGroup: string;

DeployedIndex deploymentGroup.

displayName

public displayName: string;

DeployedIndex displayName.

enableAccessLogging

public enableAccessLogging: boolean;

DeployedIndex enableAccessLogging.

id

public id: string;

DeployedIndex id.

index

public index: string;

DeployedIndex index.

indexSyncTime

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

DeployedIndex indexSyncTime.

privateEndpoints

public privateEndpoints?: (google.cloud.aiplatform.v1.IIndexPrivateEndpoints|null);

DeployedIndex privateEndpoints.

reservedIpRanges

public reservedIpRanges: string[];

DeployedIndex reservedIpRanges.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IDeployedIndex): google.cloud.aiplatform.v1.DeployedIndex;

Creates a new DeployedIndex instance using the specified properties.

Parameter

Name	Description
properties	`IDeployedIndex` Properties to set

Returns

Type	Description
google.cloud.aiplatform.v1.DeployedIndex	DeployedIndex instance

decode(reader, length)

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

Decodes a DeployedIndex 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.DeployedIndex	DeployedIndex

decodeDelimited(reader)

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

Decodes a DeployedIndex 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.DeployedIndex	DeployedIndex

encode(message, writer)

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

Encodes the specified DeployedIndex message. Does not implicitly messages.

Parameters

Name	Description
message	`IDeployedIndex` DeployedIndex 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.IDeployedIndex, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IDeployedIndex` DeployedIndex 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.DeployedIndex;

Creates a DeployedIndex 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.DeployedIndex	DeployedIndex

toJSON()

public toJSON(): { [k: string]: any };

Converts this DeployedIndex to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.aiplatform.v1.DeployedIndex` DeployedIndex
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 a DeployedIndex message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not