Interface ExportDataObjectsRequestOrBuilder (0.16.0)

public interface ExportDataObjectsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDestinationCase()

public abstract ExportDataObjectsRequest.DestinationCase getDestinationCase()
Returns
Type Description
ExportDataObjectsRequest.DestinationCase

getFieldFilter()

public abstract ExportDataObjectsRequest.FieldFilter 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.

.google.cloud.vectorsearch.v1beta.ExportDataObjectsRequest.FieldFilter field_filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExportDataObjectsRequest.FieldFilter

The fieldFilter.

getFieldFilterOrBuilder()

public abstract ExportDataObjectsRequest.FieldFilterOrBuilder getFieldFilterOrBuilder()

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.

.google.cloud.vectorsearch.v1beta.ExportDataObjectsRequest.FieldFilter field_filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExportDataObjectsRequest.FieldFilterOrBuilder

getGcsDestination()

public abstract ExportDataObjectsRequest.GcsExportDestination getGcsDestination()

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

.google.cloud.vectorsearch.v1beta.ExportDataObjectsRequest.GcsExportDestination gcs_destination = 2;

Returns
Type Description
ExportDataObjectsRequest.GcsExportDestination

The gcsDestination.

getGcsDestinationOrBuilder()

public abstract ExportDataObjectsRequest.GcsExportDestinationOrBuilder getGcsDestinationOrBuilder()

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

.google.cloud.vectorsearch.v1beta.ExportDataObjectsRequest.GcsExportDestination gcs_destination = 2;

Returns
Type Description
ExportDataObjectsRequest.GcsExportDestinationOrBuilder

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

hasFieldFilter()

public abstract boolean hasFieldFilter()

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.

.google.cloud.vectorsearch.v1beta.ExportDataObjectsRequest.FieldFilter field_filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the fieldFilter field is set.

hasGcsDestination()

public abstract boolean hasGcsDestination()

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

.google.cloud.vectorsearch.v1beta.ExportDataObjectsRequest.GcsExportDestination gcs_destination = 2;

Returns
Type Description
boolean

Whether the gcsDestination field is set.