org.tensorflow.distruntime.RecvTensorRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nd4j-api Show documentation
There is a newer version: 1.0.0-M2.1
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: tensorflow/core/protobuf/worker.proto

package org.tensorflow.distruntime;

public interface RecvTensorRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:tensorflow.RecvTensorRequest)
    org.nd4j.shade.protobuf.MessageOrBuilder {

  /**
   *    * The step in which the tensor will be produced.
   * REQUIRED: This must eventually correspond to the `step_id` passed
   * into a RunGraph call on the same WorkerService.
   * 
   *
   * int64 step_id = 1;
   */
  long getStepId();

  /**
   *    * A key identifying the channel to receive tensors from. A RecvTensor request
   * retrieves one tensor from the channel, but multiple tensors can be sent and
   * received over the same channel with multiple RecvTensor requests. See
   * rendezvous.h for details.
   * 
   *
   * string rendezvous_key = 2;
   */
  java.lang.String getRendezvousKey();
  /**
   *    * A key identifying the channel to receive tensors from. A RecvTensor request
   * retrieves one tensor from the channel, but multiple tensors can be sent and
   * received over the same channel with multiple RecvTensor requests. See
   * rendezvous.h for details.
   * 
   *
   * string rendezvous_key = 2;
   */
  org.nd4j.shade.protobuf.ByteString
      getRendezvousKeyBytes();

  /**
   *    * If true, use an out-of-band DMA mechanism to transfer the
   * received tensor.
   * 
   *
   * bool dma_ok = 3;
   */
  boolean getDmaOk();

  /**
   *    * Optional information on client-side device locality.
   * 
   *
   * .tensorflow.DeviceLocality client_locality = 4;
   */
  boolean hasClientLocality();
  /**
   *    * Optional information on client-side device locality.
   * 
   *
   * .tensorflow.DeviceLocality client_locality = 4;
   */
  org.tensorflow.framework.DeviceLocality getClientLocality();
  /**
   *    * Optional information on client-side device locality.
   * 
   *
   * .tensorflow.DeviceLocality client_locality = 4;
   */
  org.tensorflow.framework.DeviceLocalityOrBuilder getClientLocalityOrBuilder();

  /**
   *    * Optional information on server-side device locality.
   * 
   *
   * .tensorflow.DeviceLocality server_locality = 5;
   */
  boolean hasServerLocality();
  /**
   *    * Optional information on server-side device locality.
   * 
   *
   * .tensorflow.DeviceLocality server_locality = 5;
   */
  org.tensorflow.framework.DeviceLocality getServerLocality();
  /**
   *    * Optional information on server-side device locality.
   * 
   *
   * .tensorflow.DeviceLocality server_locality = 5;
   */
  org.tensorflow.framework.DeviceLocalityOrBuilder getServerLocalityOrBuilder();

  /**
   *    * Optional information needed by the RPC subsystem.
   * 
   *
   * .google.protobuf.Any transport_options = 6;
   */
  boolean hasTransportOptions();
  /**
   *    * Optional information needed by the RPC subsystem.
   * 
   *
   * .google.protobuf.Any transport_options = 6;
   */
  org.nd4j.shade.protobuf.Any getTransportOptions();
  /**
   *    * Optional information needed by the RPC subsystem.
   * 
   *
   * .google.protobuf.Any transport_options = 6;
   */
  org.nd4j.shade.protobuf.AnyOrBuilder getTransportOptionsOrBuilder();

  /**
   *    * Unique identifier for this request. Every RecvTensorRequest must have a
   * unique request_id, and retried RecvTensorRequests must have the same
   * request_id. If request_id is zero, retry detection is disabled.
   * Retried RecvTensorRequests are problematic because a RecvTensor with no
   * corresponding sender will wait forever, and the tensor may have been
   * delivered to a previous retry. Workers use request_ids to reject retried
   * RecvTensor requests instead of waiting forever.
   * 
   *
   * int64 request_id = 7;
   */
  long getRequestId();
}