Google Cloud Vector Search V1 Client - Class ExportDataObjectsRequest (0.5.0)

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

Request message for VectorSearchService.ExportDataObjects.

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

Namespace

Google \ Cloud \ VectorSearch \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ gcs_destination`	`ExportDataObjectsRequest\GcsExportDestination` The Cloud Storage location where user wants to export Data Objects.
`↳ name`	`string` Required. The resource name of the Collection from which we want to export Data Objects. Format: `projects/{project}/locations/{location}/collections/{collection}`.
`↳ field_filter`	`ExportDataObjectsRequest\FieldFilter` Optional. Restricts which top-level Data Object fields appear in each exported JSONL record. If unset, every field is exported (the existing behavior). The primary use case is excluding the per-object `etag` so that the exported records can be imported into a Collection in a different region without optimistic-concurrency conflicts. Allowed field names are `id`, `data`, `vectors`, `etag`.

getGcsDestination

The Cloud Storage location where user wants to export Data Objects.

Returns
Type	Description
`ExportDataObjectsRequest\GcsExportDestination\|null`

hasGcsDestination

setGcsDestination

The Cloud Storage location where user wants to export Data Objects.

Parameter
Name	Description
`var`	`ExportDataObjectsRequest\GcsExportDestination`

Returns
Type	Description
`$this`

getName

Required. The resource name of the Collection from which we want to export Data Objects. Format: projects/{project}/locations/{location}/collections/{collection}.

Returns
Type	Description
`string`

setName

Required. The resource name of the Collection from which we want to export Data Objects. Format: projects/{project}/locations/{location}/collections/{collection}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFieldFilter

Optional. Restricts which top-level Data Object fields appear in each exported JSONL record. If unset, every field is exported (the existing behavior). The primary use case is excluding the per-object etag so that the exported records can be imported into a Collection in a different region without optimistic-concurrency conflicts.

Allowed field names are id, data, vectors, etag.

Returns
Type	Description
`ExportDataObjectsRequest\FieldFilter\|null`

hasFieldFilter

clearFieldFilter

setFieldFilter