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()
    Advisory, point-in-time hint: this source's content is local and cheap to read right now.
    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)
    All tensor descriptors in this source metadata_json field not populated here (source-level metadata only)
    int
    getTensorsCount()
    All tensor descriptors in this source metadata_json field not populated here (source-level metadata only)
    List<TensorDescriptor>
    getTensorsList()
    All tensor descriptors in this source metadata_json field not populated here (source-level metadata only)
    TensorDescriptorOrBuilder
    getTensorsOrBuilder(int index)
    All tensor descriptors in this source metadata_json field not populated here (source-level metadata only)
    List<? extends TensorDescriptorOrBuilder>
    getTensorsOrBuilderList()
    All tensor descriptors in this source metadata_json field not populated here (source-level metadata only)
    boolean
    hasDataResident()
    Advisory, point-in-time hint: this source's content is local and cheap to read right now.

    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()
       All tensor descriptors in this source
 metadata_json field not populated here (source-level metadata only)
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getTensors

      TensorDescriptor getTensors(int index)
       All tensor descriptors in this source
 metadata_json field not populated here (source-level metadata only)
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getTensorsCount

      int getTensorsCount()
       All tensor descriptors in this source
 metadata_json field not populated here (source-level metadata only)
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getTensorsOrBuilderList

      List<? extends TensorDescriptorOrBuilder> getTensorsOrBuilderList()
       All tensor descriptors in this source
 metadata_json field not populated here (source-level metadata only)
      repeated .biopb.tensor.TensorDescriptor tensors = 4;

    • getTensorsOrBuilder

      TensorDescriptorOrBuilder getTensorsOrBuilder(int index)
       All tensor descriptors in this source
 metadata_json field not populated here (source-level metadata only)
      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()
       Advisory, point-in-time hint: this source's content is local and cheap to
 read right now. VOLATILE -- a synced-folder source can re-dehydrate under
 storage pressure, so the authoritative residency gate is a fresh stat
 (adapter.is_resident()), not this stored value. `optional` so absence is
 distinguishable from false: servers predating this field leave it unset
 (residency unknown); a resident local source sets it true, a remote
 (fsspec) source false until its pixels are materialized locally.
      optional bool data_resident = 6;
      Returns:
      Whether the dataResident field is set.

    • getDataResident

      boolean getDataResident()
       Advisory, point-in-time hint: this source's content is local and cheap to
 read right now. VOLATILE -- a synced-folder source can re-dehydrate under
 storage pressure, so the authoritative residency gate is a fresh stat
 (adapter.is_resident()), not this stored value. `optional` so absence is
 distinguishable from false: servers predating this field leave it unset
 (residency unknown); a resident local source sets it true, a remote
 (fsspec) source false until its pixels are materialized locally.
      optional bool data_resident = 6;
      Returns:
      The dataResident.