Google Cloud Vector Search V1 Client - Class DeleteDataObjectRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Vector Search V1 Client class DeleteDataObjectRequest.

Request message for DataObjectService.DeleteDataObject.

Generated from protobuf message google.cloud.vectorsearch.v1.DeleteDataObjectRequest

Namespace

Google \ Cloud \ VectorSearch \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The name of the DataObject resource to be deleted. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}
↳ etag string

Optional. The current etag of the DataObject. If an etag is provided and does not match the current etag of the DataObject, deletion will be blocked and an ABORTED error will be returned.

getName

Required. The name of the DataObject resource to be deleted.

Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

Returns
Type Description
string

setName

Required. The name of the DataObject resource to be deleted.

Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. The current etag of the DataObject.

If an etag is provided and does not match the current etag of the DataObject, deletion will be blocked and an ABORTED error will be returned.

Returns
Type Description
string

setEtag

Optional. The current etag of the DataObject.

If an etag is provided and does not match the current etag of the DataObject, deletion will be blocked and an ABORTED error will be returned.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the DataObject resource to be deleted. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject} Please see DataObjectServiceClient::dataObjectName() for help formatting this field.
Returns
Type Description
DeleteDataObjectRequest