Package biopb.tensor

Interface SetUploadStatusOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getArrayId()
    What is being moved, as `add_tensor` answered with it: `<source_id>/@fields/<name>` for an uploaded tensor, or a label set's `<image array_id>/@labels/<name>`.
    com.google.protobuf.ByteString
    getArrayIdBytes()
    What is being moved, as `add_tensor` answered with it: `<source_id>/@fields/<name>` for an uploaded tensor, or a label set's `<image array_id>/@labels/<name>`.
    String
    getReason()
    Why, for DISCARDED only.
    com.google.protobuf.ByteString
    getReasonBytes()
    Why, for DISCARDED only.
    UploadStatus.State
    getState()
    Where to move it: READY (publish -- seal writes, open reads) or DISCARDED (give up, and release whatever the server minted for it).
    int
    getStateValue()
    Where to move it: READY (publish -- seal writes, open reads) or DISCARDED (give up, and release whatever the server minted for it).

    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

    • getArrayId

      String getArrayId()
       What is being moved, as `add_tensor` answered with it:
 `<source_id>/@fields/<name>` for an uploaded tensor, or a label set's
 `<image array_id>/@labels/<name>`. An `array_id` rather than a
 `source_id` because what an upload tracks is always a *tensor* of a
 source, never the source itself -- a source is discovered, or is the
 scratch source the server serves, and neither takes an upload.

 It alone names the attempt: a name is single-use for the life of the
 server (`add_tensor` refuses a collision), so what it finds is what the
 caller created.
      string array_id = 1;
      Returns:
      The arrayId.

    • getArrayIdBytes

      com.google.protobuf.ByteString getArrayIdBytes()
       What is being moved, as `add_tensor` answered with it:
 `<source_id>/@fields/<name>` for an uploaded tensor, or a label set's
 `<image array_id>/@labels/<name>`. An `array_id` rather than a
 `source_id` because what an upload tracks is always a *tensor* of a
 source, never the source itself -- a source is discovered, or is the
 scratch source the server serves, and neither takes an upload.

 It alone names the attempt: a name is single-use for the life of the
 server (`add_tensor` refuses a collision), so what it finds is what the
 caller created.
      string array_id = 1;
      Returns:
      The bytes for arrayId.

    • getStateValue

      int getStateValue()
       Where to move it: READY (publish -- seal writes, open reads) or DISCARDED
 (give up, and release whatever the server minted for it). Setting the
 state it is already in is a no-op, and moving back down the ladder is
 refused. PENDING and STATE_UNSPECIFIED are not settable: an upload starts
 PENDING and nothing returns it there yet.
      .biopb.tensor.UploadStatus.State state = 2;
      Returns:
      The enum numeric value on the wire for state.

    • getState

      UploadStatus.State getState()
       Where to move it: READY (publish -- seal writes, open reads) or DISCARDED
 (give up, and release whatever the server minted for it). Setting the
 state it is already in is a no-op, and moving back down the ladder is
 refused. PENDING and STATE_UNSPECIFIED are not settable: an upload starts
 PENDING and nothing returns it there yet.
      .biopb.tensor.UploadStatus.State state = 2;
      Returns:
      The state.

    • getReason

      String getReason()
       Why, for DISCARDED only. Consumer-facing: it is what a poller waiting on
 this result reads back.
      string reason = 3;
      Returns:
      The reason.

    • getReasonBytes

      com.google.protobuf.ByteString getReasonBytes()
       Why, for DISCARDED only. Consumer-facing: it is what a poller waiting on
 this result reads back.
      string reason = 3;
      Returns:
      The bytes for reason.