Package biopb.tensor

Class TensorReadOption.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>
biopb.tensor.TensorReadOption.Builder
All Implemented Interfaces:
TensorReadOptionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TensorReadOption
public static final class TensorReadOption.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder> implements TensorReadOptionOrBuilder
 Tensor read request: the `data` flight's GetFlightInfo command.
 Flattened structure - no nested messages for read options.
Protobuf type biopb.tensor.TensorReadOption

  • Method Details

    • 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.Builder<TensorReadOption.Builder>

    • clear

      public TensorReadOption.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • getDefaultInstanceForType

      public TensorReadOption getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public TensorReadOption build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public TensorReadOption buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public TensorReadOption.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • setField

      public TensorReadOption.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • clearField

      public TensorReadOption.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • clearOneof

      public TensorReadOption.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • setRepeatedField

      public TensorReadOption.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • addRepeatedField

      public TensorReadOption.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • mergeFrom

      public TensorReadOption.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TensorReadOption.Builder>

    • mergeFrom

      public TensorReadOption.Builder mergeFrom(TensorReadOption other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • mergeFrom

      public TensorReadOption.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TensorReadOption.Builder>
      Throws:
      IOException

    • 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.

    • setArrayId

      public TensorReadOption.Builder setArrayId(String value)
       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;
      Parameters:
      value - The arrayId to set.
      Returns:
      This builder for chaining.

    • clearArrayId

      public TensorReadOption.Builder clearArrayId()
       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;
      Returns:
      This builder for chaining.

    • setArrayIdBytes

      public TensorReadOption.Builder setArrayIdBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for arrayId to set.
      Returns:
      This builder for chaining.

    • 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.

    • setSliceHint

      public TensorReadOption.Builder setSliceHint(SliceHint value)
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;

    • setSliceHint

      public TensorReadOption.Builder setSliceHint(SliceHint.Builder builderForValue)
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;

    • mergeSliceHint

      public TensorReadOption.Builder mergeSliceHint(SliceHint value)
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;

    • clearSliceHint

      public TensorReadOption.Builder clearSliceHint()
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;

    • getSliceHintBuilder

      public SliceHint.Builder getSliceHintBuilder()
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;

    • 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.

    • setScaleHint

      public TensorReadOption.Builder setScaleHint(int index, long value)
       Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
      repeated int64 scale_hint = 3;
      Parameters:
      index - The index to set the value at.
      value - The scaleHint to set.
      Returns:
      This builder for chaining.

    • addScaleHint

      public TensorReadOption.Builder addScaleHint(long value)
       Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
      repeated int64 scale_hint = 3;
      Parameters:
      value - The scaleHint to add.
      Returns:
      This builder for chaining.

    • addAllScaleHint

      public TensorReadOption.Builder addAllScaleHint(Iterable<? extends Long> values)
       Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
      repeated int64 scale_hint = 3;
      Parameters:
      values - The scaleHint to add.
      Returns:
      This builder for chaining.

    • clearScaleHint

      public TensorReadOption.Builder clearScaleHint()
       Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
      repeated int64 scale_hint = 3;
      Returns:
      This builder for chaining.

    • 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.

    • setReductionMethod

      public TensorReadOption.Builder setReductionMethod(String value)
       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;
      Parameters:
      value - The reductionMethod to set.
      Returns:
      This builder for chaining.

    • clearReductionMethod

      public TensorReadOption.Builder clearReductionMethod()
       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;
      Returns:
      This builder for chaining.

    • setReductionMethodBytes

      public TensorReadOption.Builder setReductionMethodBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for reductionMethod to set.
      Returns:
      This builder for chaining.

    • 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.

    • setFields

      public TensorReadOption.Builder setFields(com.google.protobuf.FieldMask value)
       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;

    • setFields

      public TensorReadOption.Builder setFields(com.google.protobuf.FieldMask.Builder builderForValue)
       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;

    • mergeFields

      public TensorReadOption.Builder mergeFields(com.google.protobuf.FieldMask value)
       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;

    • clearFields

      public TensorReadOption.Builder clearFields()
       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;

    • getFieldsBuilder

      public com.google.protobuf.FieldMask.Builder getFieldsBuilder()
       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;

    • 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

    • setUnknownFields

      public final TensorReadOption.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>

    • mergeUnknownFields

      public final TensorReadOption.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TensorReadOption.Builder>