Package biopb.tensor

Class TensorReadOption

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

biopb.tensor.TensorReadOption

All Implemented Interfaces:

TensorReadOptionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class TensorReadOption
extends com.google.protobuf.GeneratedMessageV3
implements TensorReadOptionOrBuilder

 Tensor read request: the `data` flight's GetFlightInfo command.
 Flattened structure - no nested messages for read options.
 

Protobuf type biopb.tensor.TensorReadOption

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TensorReadOption.Builder	Tensor read request: the `data` flight's GetFlightInfo command.

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	ARRAY_ID_FIELD_NUMBER
static final int	FIELDS_FIELD_NUMBER
static final int	REDUCTION_METHOD_FIELD_NUMBER
static final int	SCALE_HINT_FIELD_NUMBER
static final int	SLICE_HINT_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)
String	getArrayId()	Which tensor to read: its globally-unique array_id ("source_id" or "source_id/field", per the identity policy at the top of this file).
com.google.protobuf.ByteString	getArrayIdBytes()	Which tensor to read: its globally-unique array_id ("source_id" or "source_id/field", per the identity policy at the top of this file).
static TensorReadOption	getDefaultInstance()
TensorReadOption	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.FieldMask	getFields()	Which optional parts of the response to fill.
com.google.protobuf.FieldMaskOrBuilder	getFieldsOrBuilder()	Which optional parts of the response to fill.
com.google.protobuf.Parser<TensorReadOption>	getParserForType()
String	getReductionMethod()	Dynamic reduction/downsampling method: "nearest", "area", or "precompute" (serve a native on-disk pyramid level).
com.google.protobuf.ByteString	getReductionMethodBytes()	Dynamic reduction/downsampling method: "nearest", "area", or "precompute" (serve a native on-disk pyramid level).
long	getScaleHint(int index)	Per-dimension integer downsampling factors.
int	getScaleHintCount()	Per-dimension integer downsampling factors.
List<Long>	getScaleHintList()	Per-dimension integer downsampling factors.
int	getSerializedSize()
SliceHint	getSliceHint()	Optional sub-region to read
SliceHintOrBuilder	getSliceHintOrBuilder()	Optional sub-region to read
boolean	hasFields()	Which optional parts of the response to fill.
int	hashCode()
boolean	hasSliceHint()	Optional sub-region to read
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static TensorReadOption.Builder	newBuilder()
static TensorReadOption.Builder	newBuilder(TensorReadOption prototype)
TensorReadOption.Builder	newBuilderForType()
protected TensorReadOption.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TensorReadOption	parseDelimitedFrom(InputStream input)
static TensorReadOption	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TensorReadOption	parseFrom(byte[] data)
static TensorReadOption	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TensorReadOption	parseFrom(com.google.protobuf.ByteString data)
static TensorReadOption	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TensorReadOption	parseFrom(com.google.protobuf.CodedInputStream input)
static TensorReadOption	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TensorReadOption	parseFrom(InputStream input)
static TensorReadOption	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TensorReadOption	parseFrom(ByteBuffer data)
static TensorReadOption	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TensorReadOption>	parser()
TensorReadOption.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

ARRAY_ID_FIELD_NUMBER

public static final int ARRAY_ID_FIELD_NUMBER

See Also:

• Constant Field Values

SLICE_HINT_FIELD_NUMBER

public static final int SLICE_HINT_FIELD_NUMBER

See Also:

• Constant Field Values

SCALE_HINT_FIELD_NUMBER

public static final int SCALE_HINT_FIELD_NUMBER

See Also:

• Constant Field Values

REDUCTION_METHOD_FIELD_NUMBER

public static final int REDUCTION_METHOD_FIELD_NUMBER

See Also:

• Constant Field Values

FIELDS_FIELD_NUMBER

public static final int FIELDS_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

getArrayId

public String getArrayId()

 Which tensor to read: its globally-unique array_id ("source_id" or
 "source_id/field", per the identity policy at the top of this file). A bare
 source_id selects the source's default (first) tensor (#44).
 

string array_id = 1;

Specified by:

getArrayId in interface TensorReadOptionOrBuilder

Returns:

The arrayId.

getArrayIdBytes

public com.google.protobuf.ByteString getArrayIdBytes()

 Which tensor to read: its globally-unique array_id ("source_id" or
 "source_id/field", per the identity policy at the top of this file). A bare
 source_id selects the source's default (first) tensor (#44).
 

string array_id = 1;

Specified by:

getArrayIdBytes in interface TensorReadOptionOrBuilder

Returns:

The bytes for arrayId.

hasSliceHint

public boolean hasSliceHint()

 Optional sub-region to read
 

.biopb.tensor.SliceHint slice_hint = 2;

Specified by:

hasSliceHint in interface TensorReadOptionOrBuilder

Returns:

Whether the sliceHint field is set.

getSliceHint

public SliceHint getSliceHint()

 Optional sub-region to read
 

.biopb.tensor.SliceHint slice_hint = 2;

Specified by:

getSliceHint in interface TensorReadOptionOrBuilder

Returns:

The sliceHint.

getSliceHintOrBuilder

public SliceHintOrBuilder getSliceHintOrBuilder()

 Optional sub-region to read
 

.biopb.tensor.SliceHint slice_hint = 2;

Specified by:

getSliceHintOrBuilder in interface TensorReadOptionOrBuilder

getScaleHintList

public List<Long> getScaleHintList()

 Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
 

repeated int64 scale_hint = 3;

Specified by:

getScaleHintList in interface TensorReadOptionOrBuilder

Returns:

A list containing the scaleHint.

getScaleHintCount

public int getScaleHintCount()

 Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
 

repeated int64 scale_hint = 3;

Specified by:

getScaleHintCount in interface TensorReadOptionOrBuilder

Returns:

The count of scaleHint.

getScaleHint

public long getScaleHint(int index)

 Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
 

repeated int64 scale_hint = 3;

Specified by:

getScaleHint in interface TensorReadOptionOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The scaleHint at the given index.

getReductionMethod

public String getReductionMethod()

 Dynamic reduction/downsampling method: "nearest", "area", or
 "precompute" (serve a native on-disk pyramid level).
 Compatibility aliases accepted: "stride" -> "nearest", "mean" -> "area",
 "precomputed" -> "precompute", "linear" (deprecated) -> "area".
 

string reduction_method = 4;

Specified by:

getReductionMethod in interface TensorReadOptionOrBuilder

Returns:

The reductionMethod.

getReductionMethodBytes

public com.google.protobuf.ByteString getReductionMethodBytes()

 Dynamic reduction/downsampling method: "nearest", "area", or
 "precompute" (serve a native on-disk pyramid level).
 Compatibility aliases accepted: "stride" -> "nearest", "mean" -> "area",
 "precomputed" -> "precompute", "linear" (deprecated) -> "area".
 

string reduction_method = 4;

Specified by:

getReductionMethodBytes in interface TensorReadOptionOrBuilder

Returns:

The bytes for reductionMethod.

hasFields

public boolean hasFields()

 Which optional parts of the response to fill.

 **Empty means none.** The response then carries this tensor's base
 descriptor -- array_id, dim_labels, shape, chunk_shape, dtype, and the
 ~200-byte physical_scale/physical_unit, which stay unconditional as the one
 cheap describe fact -- and an empty endpoint list.

 Paths name what they fill on the response:

   "endpoints"     - the per-request chunk read plan. O(chunks); a read asks
                     for this, a describe does not.
   "metadata_json" - the full OME tree. Megabytes on a per-plane-annotated
                     file.
   "pyramid"       - the advertised resolution pyramid. Sizing a native one
                     opens each level's store (network I/O per level on a
                     cloud store).
   "upload_status" - progress of the upload backing this tensor, if any.
                     The one cheap path: an in-memory record read.
   "is_resident"   - whether the bytes are local right now. A bounded stat
                     walk of the source (biopb/biopb#1035).

 Opt-in throughout, and that is the point of replacing the three `with_*`
 bools this supersedes: they defaulted the *most* expensive part, the read
 plan, to on, so a describe had to remember to turn it off. Nothing here is
 free, so nothing here is default.

 An unknown path is refused, not ignored: a client asking for something this
 server does not serve should learn so, rather than silently receive a
 response missing the field it planned around.
 

.google.protobuf.FieldMask fields = 9;

Specified by:

hasFields in interface TensorReadOptionOrBuilder

Returns:

Whether the fields field is set.

getFields

public com.google.protobuf.FieldMask getFields()

 Which optional parts of the response to fill.

 **Empty means none.** The response then carries this tensor's base
 descriptor -- array_id, dim_labels, shape, chunk_shape, dtype, and the
 ~200-byte physical_scale/physical_unit, which stay unconditional as the one
 cheap describe fact -- and an empty endpoint list.

 Paths name what they fill on the response:

   "endpoints"     - the per-request chunk read plan. O(chunks); a read asks
                     for this, a describe does not.
   "metadata_json" - the full OME tree. Megabytes on a per-plane-annotated
                     file.
   "pyramid"       - the advertised resolution pyramid. Sizing a native one
                     opens each level's store (network I/O per level on a
                     cloud store).
   "upload_status" - progress of the upload backing this tensor, if any.
                     The one cheap path: an in-memory record read.
   "is_resident"   - whether the bytes are local right now. A bounded stat
                     walk of the source (biopb/biopb#1035).

 Opt-in throughout, and that is the point of replacing the three `with_*`
 bools this supersedes: they defaulted the *most* expensive part, the read
 plan, to on, so a describe had to remember to turn it off. Nothing here is
 free, so nothing here is default.

 An unknown path is refused, not ignored: a client asking for something this
 server does not serve should learn so, rather than silently receive a
 response missing the field it planned around.
 

.google.protobuf.FieldMask fields = 9;

Specified by:

getFields in interface TensorReadOptionOrBuilder

Returns:

The fields.

getFieldsOrBuilder

public com.google.protobuf.FieldMaskOrBuilder getFieldsOrBuilder()

 Which optional parts of the response to fill.

 **Empty means none.** The response then carries this tensor's base
 descriptor -- array_id, dim_labels, shape, chunk_shape, dtype, and the
 ~200-byte physical_scale/physical_unit, which stay unconditional as the one
 cheap describe fact -- and an empty endpoint list.

 Paths name what they fill on the response:

   "endpoints"     - the per-request chunk read plan. O(chunks); a read asks
                     for this, a describe does not.
   "metadata_json" - the full OME tree. Megabytes on a per-plane-annotated
                     file.
   "pyramid"       - the advertised resolution pyramid. Sizing a native one
                     opens each level's store (network I/O per level on a
                     cloud store).
   "upload_status" - progress of the upload backing this tensor, if any.
                     The one cheap path: an in-memory record read.
   "is_resident"   - whether the bytes are local right now. A bounded stat
                     walk of the source (biopb/biopb#1035).

 Opt-in throughout, and that is the point of replacing the three `with_*`
 bools this supersedes: they defaulted the *most* expensive part, the read
 plan, to on, so a describe had to remember to turn it off. Nothing here is
 free, so nothing here is default.

 An unknown path is refused, not ignored: a client asking for something this
 server does not serve should learn so, rather than silently receive a
 response missing the field it planned around.
 

.google.protobuf.FieldMask fields = 9;

Specified by:

getFieldsOrBuilder in interface TensorReadOptionOrBuilder

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 TensorReadOption parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TensorReadOption parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TensorReadOption parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TensorReadOption parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TensorReadOption parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TensorReadOption parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TensorReadOption parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static TensorReadOption parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static TensorReadOption parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static TensorReadOption parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static TensorReadOption parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static TensorReadOption parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public TensorReadOption.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TensorReadOption.Builder newBuilder()

newBuilder

public static TensorReadOption.Builder newBuilder(TensorReadOption prototype)

toBuilder

public TensorReadOption.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TensorReadOption.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TensorReadOption getDefaultInstance()

parser

public static com.google.protobuf.Parser<TensorReadOption> parser()

getParserForType

public com.google.protobuf.Parser<TensorReadOption> 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 TensorReadOption getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder