Package tensorflow.serving

Class Predict.PredictRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
tensorflow.serving.Predict.PredictRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Predict.PredictRequestOrBuilder
Enclosing class:
Predict
public static final class Predict.PredictRequest extends com.google.protobuf.GeneratedMessageV3 implements Predict.PredictRequestOrBuilder
 PredictRequest specifies which TensorFlow model to run, as well as
 how inputs are mapped to tensors and how outputs are filtered before
 returning to user.
Protobuf type tensorflow.serving.PredictRequest
See Also:

  • Field Details

    • MODEL_SPEC_FIELD_NUMBER

      public static final int MODEL_SPEC_FIELD_NUMBER
      See Also:

    • INPUTS_FIELD_NUMBER

      public static final int INPUTS_FIELD_NUMBER
      See Also:

    • OUTPUT_FILTER_FIELD_NUMBER

      public static final int OUTPUT_FILTER_FIELD_NUMBER
      See Also:

    • PREDICT_STREAMED_OPTIONS_FIELD_NUMBER

      public static final int PREDICT_STREAMED_OPTIONS_FIELD_NUMBER
      See Also:

    • CLIENT_ID_FIELD_NUMBER

      public static final int CLIENT_ID_FIELD_NUMBER
      See Also:

    • REQUEST_OPTIONS_FIELD_NUMBER

      public static final int REQUEST_OPTIONS_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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasModelSpec

      public boolean hasModelSpec()
       Model Specification. If version is not specified, will use the latest
 (numerical) version.
      .tensorflow.serving.ModelSpec model_spec = 1;
      Specified by:
      hasModelSpec in interface Predict.PredictRequestOrBuilder
      Returns:
      Whether the modelSpec field is set.

    • getModelSpec

      public Model.ModelSpec getModelSpec()
       Model Specification. If version is not specified, will use the latest
 (numerical) version.
      .tensorflow.serving.ModelSpec model_spec = 1;
      Specified by:
      getModelSpec in interface Predict.PredictRequestOrBuilder
      Returns:
      The modelSpec.

    • getModelSpecOrBuilder

      public Model.ModelSpecOrBuilder getModelSpecOrBuilder()
       Model Specification. If version is not specified, will use the latest
 (numerical) version.
      .tensorflow.serving.ModelSpec model_spec = 1;
      Specified by:
      getModelSpecOrBuilder in interface Predict.PredictRequestOrBuilder

    • getInputsCount

      public int getInputsCount()
      Description copied from interface: Predict.PredictRequestOrBuilder
       Input tensors.
 Names of input tensor are alias names. The mapping from aliases to real
 input tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'inputs' field.
      map<string, .tensorflow.TensorProto> inputs = 2;
      Specified by:
      getInputsCount in interface Predict.PredictRequestOrBuilder

    • containsInputs

      public boolean containsInputs(String key)
       Input tensors.
 Names of input tensor are alias names. The mapping from aliases to real
 input tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'inputs' field.
      map<string, .tensorflow.TensorProto> inputs = 2;
      Specified by:
      containsInputs in interface Predict.PredictRequestOrBuilder

    • getInputs

      @Deprecated public Map<String,TensorProto> getInputs()
      Deprecated.
      Use getInputsMap() instead.
      Specified by:
      getInputs in interface Predict.PredictRequestOrBuilder

    • getInputsMap

      public Map<String,TensorProto> getInputsMap()
       Input tensors.
 Names of input tensor are alias names. The mapping from aliases to real
 input tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'inputs' field.
      map<string, .tensorflow.TensorProto> inputs = 2;
      Specified by:
      getInputsMap in interface Predict.PredictRequestOrBuilder

    • getInputsOrDefault

      public TensorProto getInputsOrDefault(String key, TensorProto defaultValue)
       Input tensors.
 Names of input tensor are alias names. The mapping from aliases to real
 input tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'inputs' field.
      map<string, .tensorflow.TensorProto> inputs = 2;
      Specified by:
      getInputsOrDefault in interface Predict.PredictRequestOrBuilder

    • getInputsOrThrow

      public TensorProto getInputsOrThrow(String key)
       Input tensors.
 Names of input tensor are alias names. The mapping from aliases to real
 input tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'inputs' field.
      map<string, .tensorflow.TensorProto> inputs = 2;
      Specified by:
      getInputsOrThrow in interface Predict.PredictRequestOrBuilder

    • getOutputFilterList

      public com.google.protobuf.ProtocolStringList getOutputFilterList()
       Output filter.
 Names specified are alias names. The mapping from aliases to real output
 tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'outputs' field.
 Only tensors specified here will be run/fetched and returned, with the
 exception that when none is specified, all tensors specified in the
 named signature will be run/fetched and returned.
      repeated string output_filter = 3;
      Specified by:
      getOutputFilterList in interface Predict.PredictRequestOrBuilder
      Returns:
      A list containing the outputFilter.

    • getOutputFilterCount

      public int getOutputFilterCount()
       Output filter.
 Names specified are alias names. The mapping from aliases to real output
 tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'outputs' field.
 Only tensors specified here will be run/fetched and returned, with the
 exception that when none is specified, all tensors specified in the
 named signature will be run/fetched and returned.
      repeated string output_filter = 3;
      Specified by:
      getOutputFilterCount in interface Predict.PredictRequestOrBuilder
      Returns:
      The count of outputFilter.

    • getOutputFilter

      public String getOutputFilter(int index)
       Output filter.
 Names specified are alias names. The mapping from aliases to real output
 tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'outputs' field.
 Only tensors specified here will be run/fetched and returned, with the
 exception that when none is specified, all tensors specified in the
 named signature will be run/fetched and returned.
      repeated string output_filter = 3;
      Specified by:
      getOutputFilter in interface Predict.PredictRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The outputFilter at the given index.

    • getOutputFilterBytes

      public com.google.protobuf.ByteString getOutputFilterBytes(int index)
       Output filter.
 Names specified are alias names. The mapping from aliases to real output
 tensor names is stored in the SavedModel export as a prediction
 SignatureDef under the 'outputs' field.
 Only tensors specified here will be run/fetched and returned, with the
 exception that when none is specified, all tensors specified in the
 named signature will be run/fetched and returned.
      repeated string output_filter = 3;
      Specified by:
      getOutputFilterBytes in interface Predict.PredictRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the outputFilter at the given index.

    • hasPredictStreamedOptions

      public boolean hasPredictStreamedOptions()
       Options for streaming requests to control how multiple requests/responses
 are handled within a single stream.
      .tensorflow.serving.PredictStreamedOptions predict_streamed_options = 5;
      Specified by:
      hasPredictStreamedOptions in interface Predict.PredictRequestOrBuilder
      Returns:
      Whether the predictStreamedOptions field is set.

    • getPredictStreamedOptions

      public Predict.PredictStreamedOptions getPredictStreamedOptions()
       Options for streaming requests to control how multiple requests/responses
 are handled within a single stream.
      .tensorflow.serving.PredictStreamedOptions predict_streamed_options = 5;
      Specified by:
      getPredictStreamedOptions in interface Predict.PredictRequestOrBuilder
      Returns:
      The predictStreamedOptions.

    • getPredictStreamedOptionsOrBuilder

      public Predict.PredictStreamedOptionsOrBuilder getPredictStreamedOptionsOrBuilder()
       Options for streaming requests to control how multiple requests/responses
 are handled within a single stream.
      .tensorflow.serving.PredictStreamedOptions predict_streamed_options = 5;
      Specified by:
      getPredictStreamedOptionsOrBuilder in interface Predict.PredictRequestOrBuilder

    • hasClientId

      public boolean hasClientId()
       Client identifier to group requests belonging to a specific entity.
 Example entities can be product ids, service names, user ids etc.
 Servers can use this to optimize placement, caching and colocation.
 TODO(b/329897437): Migrate to client_id in RequestOptions.
      optional bytes client_id = 6;
      Specified by:
      hasClientId in interface Predict.PredictRequestOrBuilder
      Returns:
      Whether the clientId field is set.

    • getClientId

      public com.google.protobuf.ByteString getClientId()
       Client identifier to group requests belonging to a specific entity.
 Example entities can be product ids, service names, user ids etc.
 Servers can use this to optimize placement, caching and colocation.
 TODO(b/329897437): Migrate to client_id in RequestOptions.
      optional bytes client_id = 6;
      Specified by:
      getClientId in interface Predict.PredictRequestOrBuilder
      Returns:
      The clientId.

    • hasRequestOptions

      public boolean hasRequestOptions()
      optional .tensorflow.serving.PredictRequest.RequestOptions request_options = 7;
      Specified by:
      hasRequestOptions in interface Predict.PredictRequestOrBuilder
      Returns:
      Whether the requestOptions field is set.

    • getRequestOptions

      public Predict.PredictRequest.RequestOptions getRequestOptions()
      optional .tensorflow.serving.PredictRequest.RequestOptions request_options = 7;
      Specified by:
      getRequestOptions in interface Predict.PredictRequestOrBuilder
      Returns:
      The requestOptions.

    • getRequestOptionsOrBuilder

      public Predict.PredictRequest.RequestOptionsOrBuilder getRequestOptionsOrBuilder()
      optional .tensorflow.serving.PredictRequest.RequestOptions request_options = 7;
      Specified by:
      getRequestOptionsOrBuilder in interface Predict.PredictRequestOrBuilder

    • 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 Predict.PredictRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Predict.PredictRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Predict.PredictRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Predict.PredictRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Predict.PredictRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Predict.PredictRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Predict.PredictRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Predict.PredictRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Predict.PredictRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Predict.PredictRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Predict.PredictRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Predict.PredictRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Predict.PredictRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Predict.PredictRequest.Builder newBuilder()

    • newBuilder

      public static Predict.PredictRequest.Builder newBuilder(Predict.PredictRequest prototype)

    • toBuilder

      public Predict.PredictRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Predict.PredictRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Predict.PredictRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Predict.PredictRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<Predict.PredictRequest> 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 Predict.PredictRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder