Google Cloud Ai Platform V1 Client - Class UpsertDatapointsRequest (1.5.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class UpsertDatapointsRequest.

Request message for IndexService.UpsertDatapoints

Generated from protobuf message google.cloud.aiplatform.v1.UpsertDatapointsRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ index string

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}
↳ datapoints array<Google\Cloud\AIPlatform\V1\IndexDatapoint>

A list of datapoints to be created/updated.
↳ update_mask Google\Protobuf\FieldMask

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request. Updatable fields: * Use all_restricts to update both restricts and numeric_restricts.

getIndex

Required. The name of the Index resource to be updated.

Format: projects/{project}/locations/{location}/indexes/{index}

Returns
Type Description
string

setIndex

Required. The name of the Index resource to be updated.

Format: projects/{project}/locations/{location}/indexes/{index}

Parameter
Name Description
var string
Returns
Type Description
$this

getDatapoints

A list of datapoints to be created/updated.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDatapoints

A list of datapoints to be created/updated.

Parameter
Name Description
var array<Google\Cloud\AIPlatform\V1\IndexDatapoint>
Returns
Type Description
$this

getUpdateMask

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.
Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.
Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this