Vector Search V1 API - Class Google::Cloud::VectorSearch::V1::ExportDataObjectsRequest (v0.1.0)

Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::ExportDataObjectsRequest.

Request message for VectorSearchService.ExportDataObjects.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#field_filter

def field_filter() -> ::Google::Cloud::VectorSearch::V1::ExportDataObjectsRequest::FieldFilter
Returns
  • (::Google::Cloud::VectorSearch::V1::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.

#field_filter=

def field_filter=(value) -> ::Google::Cloud::VectorSearch::V1::ExportDataObjectsRequest::FieldFilter
Parameter
  • value (::Google::Cloud::VectorSearch::V1::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.

Returns
  • (::Google::Cloud::VectorSearch::V1::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.

#gcs_destination

def gcs_destination() -> ::Google::Cloud::VectorSearch::V1::ExportDataObjectsRequest::GcsExportDestination
Returns

#gcs_destination=

def gcs_destination=(value) -> ::Google::Cloud::VectorSearch::V1::ExportDataObjectsRequest::GcsExportDestination
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Required. The resource name of the Collection from which we want to export Data Objects. Format: projects/{project}/locations/{location}/collections/{collection}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the Collection from which we want to export Data Objects. Format: projects/{project}/locations/{location}/collections/{collection}.
Returns
  • (::String) — Required. The resource name of the Collection from which we want to export Data Objects. Format: projects/{project}/locations/{location}/collections/{collection}.