Package biopb.tensor

Interface DataSourceDescriptorOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DataSourceDescriptor, DataSourceDescriptor.Builder
public interface DataSourceDescriptorOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getDataResident()
    DEAD: no current server fills this.
    String
    getMetadataJson()
    Source-level OME/vendor metadata (JSON format)
    com.google.protobuf.ByteString
    getMetadataJsonBytes()
    Source-level OME/vendor metadata (JSON format)
    String
    getSourceId()
    Unique identifier for the data source (flight identifier)
    com.google.protobuf.ByteString
    getSourceIdBytes()
    Unique identifier for the data source (flight identifier)
    String
    getSourceType()
    Source type: "aics", "micromanager", "ome-zarr", "zarr", "hdf5", etc.
    com.google.protobuf.ByteString
    getSourceTypeBytes()
    Source type: "aics", "micromanager", "ome-zarr", "zarr", "hdf5", etc.
    String
    getSourceUrl()
    File path, directory, or remote URL
    com.google.protobuf.ByteString
    getSourceUrlBytes()
    File path, directory, or remote URL
    TensorDescriptor
    getTensors(int index)
    Every tensor in this source, as a STRUCTURAL catalog entry: array_id, dim_labels, shape, dtype.
    int
    getTensorsCount()
    Every tensor in this source, as a STRUCTURAL catalog entry: array_id, dim_labels, shape, dtype.
    List<TensorDescriptor>
    getTensorsList()
    Every tensor in this source, as a STRUCTURAL catalog entry: array_id, dim_labels, shape, dtype.
    TensorDescriptorOrBuilder
    getTensorsOrBuilder(int index)
    Every tensor in this source, as a STRUCTURAL catalog entry: array_id, dim_labels, shape, dtype.
    List<? extends TensorDescriptorOrBuilder>
    getTensorsOrBuilderList()
    Every tensor in this source, as a STRUCTURAL catalog entry: array_id, dim_labels, shape, dtype.
    boolean
    hasDataResident()
    DEAD: no current server fills this.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSourceId

      String getSourceId()
       Unique identifier for the data source (flight identifier)
      string source_id = 1;
      Returns:
      The sourceId.

    • getSourceIdBytes

      com.google.protobuf.ByteString getSourceIdBytes()
       Unique identifier for the data source (flight identifier)
      string source_id = 1;
      Returns:
      The bytes for sourceId.

    • getSourceUrl

      String getSourceUrl()
       File path, directory, or remote URL
      string source_url = 2;
      Returns:
      The sourceUrl.

    • getSourceUrlBytes

      com.google.protobuf.ByteString getSourceUrlBytes()
       File path, directory, or remote URL
      string source_url = 2;
      Returns:
      The bytes for sourceUrl.

    • getSourceType

      String getSourceType()
       Source type: "aics", "micromanager", "ome-zarr", "zarr", "hdf5", etc.
      string source_type = 3;
      Returns:
      The sourceType.

    • getSourceTypeBytes

      com.google.protobuf.ByteString getSourceTypeBytes()
       Source type: "aics", "micromanager", "ome-zarr", "zarr", "hdf5", etc.
      string source_type = 3;
      Returns:
      The bytes for sourceType.

    • getTensorsList

      List<TensorDescriptor> getTensorsList()
       Every tensor in this source, as a STRUCTURAL catalog entry: array_id,
 dim_labels, shape, dtype. The serving fields are left empty here --
 chunk_shape (the transfer grid), pyramid, physical_scale, metadata_json --
 because a source lists all its tensors without binding any of them, and
 those are answered by the adapter GetFlightInfo binds to one tensor. Read
 this to enumerate and address; describe the tensor to plan a read.
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getTensors

      TensorDescriptor getTensors(int index)
       Every tensor in this source, as a STRUCTURAL catalog entry: array_id,
 dim_labels, shape, dtype. The serving fields are left empty here --
 chunk_shape (the transfer grid), pyramid, physical_scale, metadata_json --
 because a source lists all its tensors without binding any of them, and
 those are answered by the adapter GetFlightInfo binds to one tensor. Read
 this to enumerate and address; describe the tensor to plan a read.
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getTensorsCount

      int getTensorsCount()
       Every tensor in this source, as a STRUCTURAL catalog entry: array_id,
 dim_labels, shape, dtype. The serving fields are left empty here --
 chunk_shape (the transfer grid), pyramid, physical_scale, metadata_json --
 because a source lists all its tensors without binding any of them, and
 those are answered by the adapter GetFlightInfo binds to one tensor. Read
 this to enumerate and address; describe the tensor to plan a read.
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getTensorsOrBuilderList

      List<? extends TensorDescriptorOrBuilder> getTensorsOrBuilderList()
       Every tensor in this source, as a STRUCTURAL catalog entry: array_id,
 dim_labels, shape, dtype. The serving fields are left empty here --
 chunk_shape (the transfer grid), pyramid, physical_scale, metadata_json --
 because a source lists all its tensors without binding any of them, and
 those are answered by the adapter GetFlightInfo binds to one tensor. Read
 this to enumerate and address; describe the tensor to plan a read.
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getTensorsOrBuilder

      TensorDescriptorOrBuilder getTensorsOrBuilder(int index)
       Every tensor in this source, as a STRUCTURAL catalog entry: array_id,
 dim_labels, shape, dtype. The serving fields are left empty here --
 chunk_shape (the transfer grid), pyramid, physical_scale, metadata_json --
 because a source lists all its tensors without binding any of them, and
 those are answered by the adapter GetFlightInfo binds to one tensor. Read
 this to enumerate and address; describe the tensor to plan a read.
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getMetadataJson

      String getMetadataJson()
       Source-level OME/vendor metadata (JSON format)
      string metadata_json = 5;
      Returns:
      The metadataJson.

    • getMetadataJsonBytes

      com.google.protobuf.ByteString getMetadataJsonBytes()
       Source-level OME/vendor metadata (JSON format)
      string metadata_json = 5;
      Returns:
      The bytes for metadataJson.

    • hasDataResident

      boolean hasDataResident()
       DEAD: no current server fills this. Residency is volatile -- a
 synced-folder source re-dehydrates with no event to refresh from -- so the
 catalog dropped its column and the `is_resident` action answers it live
 (biopb/biopb#1035). Kept only so the deprecated row decoders still fill it
 from an older server's row.
      optional bool data_resident = 6;
      Returns:
      Whether the dataResident field is set.

    • getDataResident

      boolean getDataResident()
       DEAD: no current server fills this. Residency is volatile -- a
 synced-folder source re-dehydrates with no event to refresh from -- so the
 catalog dropped its column and the `is_resident` action answers it live
 (biopb/biopb#1035). Kept only so the deprecated row decoders still fill it
 from an older server's row.
      optional bool data_resident = 6;
      Returns:
      The dataResident.