Package biopb.tensor

Interface TensorReadOptionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TensorReadOption, TensorReadOption.Builder
public interface TensorReadOptionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    SliceHint
    getSliceHint()
    Optional sub-region to read
    SliceHintOrBuilder
    getSliceHintOrBuilder()
    Optional sub-region to read
    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.
    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.
    boolean
    getWithMetadata()
    If true, server populates metadata_json with wrapped metadata.
    boolean
    hasSliceHint()
    Optional sub-region to read

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getTensorId

      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;
      Returns:
      The tensorId.

    • getTensorIdBytes

      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;
      Returns:
      The bytes for tensorId.

    • hasSliceHint

      boolean hasSliceHint()
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;
      Returns:
      Whether the sliceHint field is set.

    • getSliceHint

      SliceHint getSliceHint()
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;
      Returns:
      The sliceHint.

    • getSliceHintOrBuilder

      SliceHintOrBuilder getSliceHintOrBuilder()
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;

    • getScaleHintList

      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;
      Returns:
      A list containing the scaleHint.

    • getScaleHintCount

      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;
      Returns:
      The count of scaleHint.

    • getScaleHint

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The scaleHint at the given index.

    • getReductionMethod

      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;
      Returns:
      The reductionMethod.

    • getReductionMethodBytes

      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;
      Returns:
      The bytes for reductionMethod.

    • getWithMetadata

      boolean getWithMetadata()
       If true, server populates metadata_json with wrapped metadata.
 Wrapped structure: {"type": source_type, "dim_label": [...], "metadata": {...}}
      bool with_metadata = 5;
      Returns:
      The withMetadata.