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 within a data source.
 Flattened structure - no nested messages for read options.
 Used in FlightCmd.tensor_read branch.
 
Protobuf type biopb.tensor.TensorReadOption
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Tensor read request within a data source.

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

    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
     
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Parser<TensorReadOption>
     
    Dynamic reduction/downsampling method: "nearest", "area", or "precompute" (serve a native on-disk pyramid level).
    com.google.protobuf.ByteString
    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
    Per-dimension integer downsampling factors.
    Per-dimension integer downsampling factors.
    int
     
    Optional sub-region to read
    Optional sub-region to read
    Which tensor to read -- normally the globally-unique array_id (see the tensor identity policy at the top of this file); the same value as TensorDescriptor.array_id.
    com.google.protobuf.ByteString
    Which tensor to read -- normally the globally-unique array_id (see the tensor identity policy at the top of this file); the same value as TensorDescriptor.array_id.
    boolean
    If true, server populates metadata_json with wrapped metadata.
    int
     
    boolean
    Optional sub-region to read
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TensorReadOption>
     
     
    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

    • TENSOR_ID_FIELD_NUMBER

      public static final int TENSOR_ID_FIELD_NUMBER
      See Also:
    • SLICE_HINT_FIELD_NUMBER

      public static final int SLICE_HINT_FIELD_NUMBER
      See Also:
    • SCALE_HINT_FIELD_NUMBER

      public static final int SCALE_HINT_FIELD_NUMBER
      See Also:
    • REDUCTION_METHOD_FIELD_NUMBER

      public static final int REDUCTION_METHOD_FIELD_NUMBER
      See Also:
    • WITH_METADATA_FIELD_NUMBER

      public static final int WITH_METADATA_FIELD_NUMBER
      See Also:
  • 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
    • getTensorId

      public String getTensorId()
       Which tensor to read -- normally the globally-unique array_id (see the
       tensor identity policy at the top of this file); the same value as
       TensorDescriptor.array_id. The server strips the source_id prefix (split on
       the first '/') to resolve the within-source tensor. For back-compat it also
       accepts a bare field name or the source_id; unset/empty means "the source's
       default (first) tensor" and is resolved server-side (#44).
       
      string tensor_id = 1;
      Specified by:
      getTensorId in interface TensorReadOptionOrBuilder
      Returns:
      The tensorId.
    • getTensorIdBytes

      public com.google.protobuf.ByteString getTensorIdBytes()
       Which tensor to read -- normally the globally-unique array_id (see the
       tensor identity policy at the top of this file); the same value as
       TensorDescriptor.array_id. The server strips the source_id prefix (split on
       the first '/') to resolve the within-source tensor. For back-compat it also
       accepts a bare field name or the source_id; unset/empty means "the source's
       default (first) tensor" and is resolved server-side (#44).
       
      string tensor_id = 1;
      Specified by:
      getTensorIdBytes in interface TensorReadOptionOrBuilder
      Returns:
      The bytes for tensorId.
    • 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.
    • getWithMetadata

      public boolean getWithMetadata()
       If true, server populates metadata_json with wrapped metadata.
       Wrapped structure: {"type": source_type, "dim_label": [...], "metadata": {...}}
       
      bool with_metadata = 5;
      Specified by:
      getWithMetadata in interface TensorReadOptionOrBuilder
      Returns:
      The withMetadata.
    • 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