java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

biopb.tensor.DataSourceDescriptor

All Implemented Interfaces:: DataSourceDescriptorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DataSourceDescriptor extends com.google.protobuf.GeneratedMessageV3 implements DataSourceDescriptorOrBuilder

 Describes a data source containing one or more tensors. Enables multifield
 support where tensors within a source have different shapes.

 NOT a wire type: no message carries one, and no action returns one. A source
 crosses the wire only as its `sources` catalog row, and each SDK rebuilds
 this from that row as its own structural view. The shapes are identical --
 this is here to name the row's fields and their contract, not to be a second
 encoding of them. Do not put it back on an action.

Protobuf type biopb.tensor.DataSourceDescriptor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static final class

DataSourceDescriptor.Builder

Describes a data source containing one or more tensors.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
Field Summary

Fields

Modifier and Type

Field

Description

static final int

DATA_RESIDENT_FIELD_NUMBER

static final int

METADATA_JSON_FIELD_NUMBER

static final int

SOURCE_ID_FIELD_NUMBER

static final int

SOURCE_TYPE_FIELD_NUMBER

static final int

SOURCE_URL_FIELD_NUMBER

static final int

TENSORS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
Method Summary

Modifier and Type

Method

Description

boolean

equals(Object obj)

boolean

getDataResident()

DEAD: no current server fills this.

static DataSourceDescriptor

getDefaultInstance()

DataSourceDescriptor

getDefaultInstanceForType()

static final com.google.protobuf.Descriptors.Descriptor

getDescriptor()

String

getMetadataJson()

Source-level OME/vendor metadata (JSON format)

com.google.protobuf.ByteString

getMetadataJsonBytes()

Source-level OME/vendor metadata (JSON format)

com.google.protobuf.Parser<DataSourceDescriptor>

getParserForType()

int

getSerializedSize()

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.

int

hashCode()

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

internalGetFieldAccessorTable()

final boolean

isInitialized()

static DataSourceDescriptor.Builder

newBuilder()

static DataSourceDescriptor.Builder

newBuilder(DataSourceDescriptor prototype)

DataSourceDescriptor.Builder

newBuilderForType()

protected DataSourceDescriptor.Builder

newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

protected Object

newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

static DataSourceDescriptor

parseDelimitedFrom(InputStream input)

static DataSourceDescriptor

parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static DataSourceDescriptor

parseFrom(byte[] data)

static DataSourceDescriptor

parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static DataSourceDescriptor

parseFrom(com.google.protobuf.ByteString data)

static DataSourceDescriptor

parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static DataSourceDescriptor

parseFrom(com.google.protobuf.CodedInputStream input)

static DataSourceDescriptor

parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static DataSourceDescriptor

parseFrom(InputStream input)

static DataSourceDescriptor

parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static DataSourceDescriptor

parseFrom(ByteBuffer data)

static DataSourceDescriptor

parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static com.google.protobuf.Parser<DataSourceDescriptor>

parser()

DataSourceDescriptor.Builder

toBuilder()

void

writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details
- SOURCE_ID_FIELD_NUMBER
  
  public static final int SOURCE_ID_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- SOURCE_URL_FIELD_NUMBER
  
  public static final int SOURCE_URL_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- SOURCE_TYPE_FIELD_NUMBER
  
  public static final int SOURCE_TYPE_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- TENSORS_FIELD_NUMBER
  
  public static final int TENSORS_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- METADATA_JSON_FIELD_NUMBER
  
  public static final int METADATA_JSON_FIELD_NUMBER
  See Also:
  
  Constant Field Values
- DATA_RESIDENT_FIELD_NUMBER
  
  public static final int DATA_RESIDENT_FIELD_NUMBER
  See Also:
  
  Constant Field Values
Method Details
- newInstance
  
  protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
  
  Overrides:
  
  newInstance in class com.google.protobuf.GeneratedMessageV3
- getDescriptor
  
  public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
- internalGetFieldAccessorTable
  
  protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
  
  Specified by:
  
  internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
- getSourceId
  
  public String getSourceId()
  Unique identifier for the data source (flight identifier)
  string source_id = 1;
  Specified by:
  
  getSourceId in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The sourceId.
- getSourceIdBytes
  
  public com.google.protobuf.ByteString getSourceIdBytes()
  Unique identifier for the data source (flight identifier)
  string source_id = 1;
  Specified by:
  
  getSourceIdBytes in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The bytes for sourceId.
- getSourceUrl
  
  public String getSourceUrl()
  File path, directory, or remote URL
  string source_url = 2;
  Specified by:
  
  getSourceUrl in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The sourceUrl.
- getSourceUrlBytes
  
  public com.google.protobuf.ByteString getSourceUrlBytes()
  File path, directory, or remote URL
  string source_url = 2;
  Specified by:
  
  getSourceUrlBytes in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The bytes for sourceUrl.
- getSourceType
  
  public String getSourceType()
  Source type: "aics", "micromanager", "ome-zarr", "zarr", "hdf5", etc.
  string source_type = 3;
  Specified by:
  
  getSourceType in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The sourceType.
- getSourceTypeBytes
  
  public com.google.protobuf.ByteString getSourceTypeBytes()
  Source type: "aics", "micromanager", "ome-zarr", "zarr", "hdf5", etc.
  string source_type = 3;
  Specified by:
  
  getSourceTypeBytes in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The bytes for sourceType.
- getTensorsList
  
  public 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;
  Specified by:
  
  getTensorsList in interface DataSourceDescriptorOrBuilder
- getTensorsOrBuilderList
  
  public 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;
  Specified by:
  
  getTensorsOrBuilderList in interface DataSourceDescriptorOrBuilder
- getTensorsCount
  
  public 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;
  Specified by:
  
  getTensorsCount in interface DataSourceDescriptorOrBuilder
- getTensors
  
  public 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;
  Specified by:
  
  getTensors in interface DataSourceDescriptorOrBuilder
- getTensorsOrBuilder
  
  public 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;
  Specified by:
  
  getTensorsOrBuilder in interface DataSourceDescriptorOrBuilder
- getMetadataJson
  
  public String getMetadataJson()
  Source-level OME/vendor metadata (JSON format)
  string metadata_json = 5;
  Specified by:
  
  getMetadataJson in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The metadataJson.
- getMetadataJsonBytes
  
  public com.google.protobuf.ByteString getMetadataJsonBytes()
  Source-level OME/vendor metadata (JSON format)
  string metadata_json = 5;
  Specified by:
  
  getMetadataJsonBytes in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The bytes for metadataJson.
- hasDataResident
  
  public 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;
  Specified by:
  
  hasDataResident in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  Whether the dataResident field is set.
- getDataResident
  
  public 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;
  Specified by:
  
  getDataResident in interface DataSourceDescriptorOrBuilder
  
  Returns:
  
  The dataResident.
- isInitialized
  
  public final boolean isInitialized()
  
  Specified by:
  
  isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
  
  Overrides:
  
  isInitialized in class com.google.protobuf.GeneratedMessageV3
- writeTo
  
  public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
  
  Specified by:
  
  writeTo in interface com.google.protobuf.MessageLite
  
  Overrides:
  
  writeTo in class com.google.protobuf.GeneratedMessageV3
  
  Throws:
  
  IOException
- getSerializedSize
  
  public int getSerializedSize()
  
  Specified by:
  
  getSerializedSize in interface com.google.protobuf.MessageLite
  
  Overrides:
  
  getSerializedSize in class com.google.protobuf.GeneratedMessageV3
- equals
  
  public boolean equals(Object obj)
  
  Specified by:
  
  equals in interface com.google.protobuf.Message
  
  Overrides:
  
  equals in class com.google.protobuf.AbstractMessage
- hashCode
  
  public int hashCode()
  
  Specified by:
  
  hashCode in interface com.google.protobuf.Message
  
  Overrides:
  
  hashCode in class com.google.protobuf.AbstractMessage
- parseFrom
  
  public static DataSourceDescriptor parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
  
  Throws:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
  
  Throws:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
  
  Throws:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
  
  Throws:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
  
  Throws:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
  
  Throws:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(InputStream input) throws IOException
  
  Throws:
  
  IOException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
  
  Throws:
  
  IOException
- parseDelimitedFrom
  
  public static DataSourceDescriptor parseDelimitedFrom(InputStream input) throws IOException
  
  Throws:
  
  IOException
- parseDelimitedFrom
  
  public static DataSourceDescriptor parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
  
  Throws:
  
  IOException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
  
  Throws:
  
  IOException
- parseFrom
  
  public static DataSourceDescriptor parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
  
  Throws:
  
  IOException
- newBuilderForType
  
  public DataSourceDescriptor.Builder newBuilderForType()
  
  Specified by:
  
  newBuilderForType in interface com.google.protobuf.Message
  
  Specified by:
  
  newBuilderForType in interface com.google.protobuf.MessageLite
- newBuilder
  
  public static DataSourceDescriptor.Builder newBuilder()
- newBuilder
  
  public static DataSourceDescriptor.Builder newBuilder(DataSourceDescriptor prototype)
- toBuilder
  
  public DataSourceDescriptor.Builder toBuilder()
  
  Specified by:
  
  toBuilder in interface com.google.protobuf.Message
  
  Specified by:
  
  toBuilder in interface com.google.protobuf.MessageLite
- newBuilderForType
  
  protected DataSourceDescriptor.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
  
  Specified by:
  
  newBuilderForType in class com.google.protobuf.GeneratedMessageV3
- getDefaultInstance
  
  public static DataSourceDescriptor getDefaultInstance()
- parser
  
  public static com.google.protobuf.Parser<DataSourceDescriptor> parser()
- getParserForType
  
  public com.google.protobuf.Parser<DataSourceDescriptor> getParserForType()
  
  Specified by:
  
  getParserForType in interface com.google.protobuf.Message
  
  Specified by:
  
  getParserForType in interface com.google.protobuf.MessageLite
  
  Overrides:
  
  getParserForType in class com.google.protobuf.GeneratedMessageV3
- getDefaultInstanceForType
  
  public DataSourceDescriptor getDefaultInstanceForType()
  
  Specified by:
  
  getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
  
  Specified by:
  
  getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class DataSourceDescriptor

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageLite

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Field Details

SOURCE_ID_FIELD_NUMBER

SOURCE_URL_FIELD_NUMBER

SOURCE_TYPE_FIELD_NUMBER

TENSORS_FIELD_NUMBER

METADATA_JSON_FIELD_NUMBER

DATA_RESIDENT_FIELD_NUMBER

Method Details

newInstance

getDescriptor

internalGetFieldAccessorTable

getSourceId

getSourceIdBytes

getSourceUrl

getSourceUrlBytes

getSourceType

getSourceTypeBytes

getTensorsList

getTensorsOrBuilderList

getTensorsCount

getTensors

getTensorsOrBuilder

getMetadataJson

getMetadataJsonBytes

hasDataResident

getDataResident

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType