Package com.google.cloud.aiplatform.v1

Class PredictResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.PredictResponse
All Implemented Interfaces:
PredictResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PredictResponse extends com.google.protobuf.GeneratedMessage implements PredictResponseOrBuilder
 Response message for
 [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
Protobuf type google.cloud.aiplatform.v1.PredictResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PredictResponse.Builder
    Response message for [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEPLOYED_MODEL_ID_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     
    static final int
    MODEL_DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    MODEL_FIELD_NUMBER
     
    static final int
    MODEL_VERSION_ID_FIELD_NUMBER
     
    static final int
    PREDICTIONS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static PredictResponse
    getDefaultInstance()
     
    PredictResponse
    getDefaultInstanceForType()
     
    String
    getDeployedModelId()
    ID of the Endpoint's DeployedModel that served this prediction.
    com.google.protobuf.ByteString
    getDeployedModelIdBytes()
    ID of the Endpoint's DeployedModel that served this prediction.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Value
    getMetadata()
    Output only.
    com.google.protobuf.ValueOrBuilder
    getMetadataOrBuilder()
    Output only.
    String
    getModel()
    Output only.
    com.google.protobuf.ByteString
    getModelBytes()
    Output only.
    String
    getModelDisplayName()
    Output only.
    com.google.protobuf.ByteString
    getModelDisplayNameBytes()
    Output only.
    String
    getModelVersionId()
    Output only.
    com.google.protobuf.ByteString
    getModelVersionIdBytes()
    Output only.
    com.google.protobuf.Parser<PredictResponse>
    getParserForType()
     
    com.google.protobuf.Value
    getPredictions(int index)
    The predictions that are the output of the predictions call.
    int
    getPredictionsCount()
    The predictions that are the output of the predictions call.
    List<com.google.protobuf.Value>
    getPredictionsList()
    The predictions that are the output of the predictions call.
    com.google.protobuf.ValueOrBuilder
    getPredictionsOrBuilder(int index)
    The predictions that are the output of the predictions call.
    List<? extends com.google.protobuf.ValueOrBuilder>
    getPredictionsOrBuilderList()
    The predictions that are the output of the predictions call.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasMetadata()
    Output only.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PredictResponse.Builder
    newBuilder()
     
    static PredictResponse.Builder
    newBuilder(PredictResponse prototype)
     
    PredictResponse.Builder
    newBuilderForType()
     
    protected PredictResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PredictResponse
    parseDelimitedFrom(InputStream input)
     
    static PredictResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictResponse
    parseFrom(byte[] data)
     
    static PredictResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static PredictResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PredictResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictResponse
    parseFrom(InputStream input)
     
    static PredictResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictResponse
    parseFrom(ByteBuffer data)
     
    static PredictResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PredictResponse>
    parser()
     
    PredictResponse.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PREDICTIONS_FIELD_NUMBER

      public static final int PREDICTIONS_FIELD_NUMBER
      See Also:

    • DEPLOYED_MODEL_ID_FIELD_NUMBER

      public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
      See Also:

    • MODEL_FIELD_NUMBER

      public static final int MODEL_FIELD_NUMBER
      See Also:

    • MODEL_VERSION_ID_FIELD_NUMBER

      public static final int MODEL_VERSION_ID_FIELD_NUMBER
      See Also:

    • MODEL_DISPLAY_NAME_FIELD_NUMBER

      public static final int MODEL_DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

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

    • getPredictionsList

      public List<com.google.protobuf.Value> getPredictionsList()
       The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
      repeated .google.protobuf.Value predictions = 1;
      Specified by:
      getPredictionsList in interface PredictResponseOrBuilder

    • getPredictionsOrBuilderList

      public List<? extends com.google.protobuf.ValueOrBuilder> getPredictionsOrBuilderList()
       The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
      repeated .google.protobuf.Value predictions = 1;
      Specified by:
      getPredictionsOrBuilderList in interface PredictResponseOrBuilder

    • getPredictionsCount

      public int getPredictionsCount()
       The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
      repeated .google.protobuf.Value predictions = 1;
      Specified by:
      getPredictionsCount in interface PredictResponseOrBuilder

    • getPredictions

      public com.google.protobuf.Value getPredictions(int index)
       The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
      repeated .google.protobuf.Value predictions = 1;
      Specified by:
      getPredictions in interface PredictResponseOrBuilder

    • getPredictionsOrBuilder

      public com.google.protobuf.ValueOrBuilder getPredictionsOrBuilder(int index)
       The predictions that are the output of the predictions call.
 The schema of any single prediction may be specified via Endpoint's
 DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
      repeated .google.protobuf.Value predictions = 1;
      Specified by:
      getPredictionsOrBuilder in interface PredictResponseOrBuilder

    • getDeployedModelId

      public String getDeployedModelId()
       ID of the Endpoint's DeployedModel that served this prediction.
      string deployed_model_id = 2;
      Specified by:
      getDeployedModelId in interface PredictResponseOrBuilder
      Returns:
      The deployedModelId.

    • getDeployedModelIdBytes

      public com.google.protobuf.ByteString getDeployedModelIdBytes()
       ID of the Endpoint's DeployedModel that served this prediction.
      string deployed_model_id = 2;
      Specified by:
      getDeployedModelIdBytes in interface PredictResponseOrBuilder
      Returns:
      The bytes for deployedModelId.

    • getModel

      public String getModel()
       Output only. The resource name of the Model which is deployed as the
 DeployedModel that this prediction hits.
      string model = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getModel in interface PredictResponseOrBuilder
      Returns:
      The model.

    • getModelBytes

      public com.google.protobuf.ByteString getModelBytes()
       Output only. The resource name of the Model which is deployed as the
 DeployedModel that this prediction hits.
      string model = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getModelBytes in interface PredictResponseOrBuilder
      Returns:
      The bytes for model.

    • getModelVersionId

      public String getModelVersionId()
       Output only. The version ID of the Model which is deployed as the
 DeployedModel that this prediction hits.
      string model_version_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getModelVersionId in interface PredictResponseOrBuilder
      Returns:
      The modelVersionId.

    • getModelVersionIdBytes

      public com.google.protobuf.ByteString getModelVersionIdBytes()
       Output only. The version ID of the Model which is deployed as the
 DeployedModel that this prediction hits.
      string model_version_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getModelVersionIdBytes in interface PredictResponseOrBuilder
      Returns:
      The bytes for modelVersionId.

    • getModelDisplayName

      public String getModelDisplayName()
       Output only. The [display
 name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is
 deployed as the DeployedModel that this prediction hits.
      string model_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getModelDisplayName in interface PredictResponseOrBuilder
      Returns:
      The modelDisplayName.

    • getModelDisplayNameBytes

      public com.google.protobuf.ByteString getModelDisplayNameBytes()
       Output only. The [display
 name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is
 deployed as the DeployedModel that this prediction hits.
      string model_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getModelDisplayNameBytes in interface PredictResponseOrBuilder
      Returns:
      The bytes for modelDisplayName.

    • hasMetadata

      public boolean hasMetadata()
       Output only. Request-level metadata returned by the model. The metadata
 type will be dependent upon the model implementation.
      .google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasMetadata in interface PredictResponseOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public com.google.protobuf.Value getMetadata()
       Output only. Request-level metadata returned by the model. The metadata
 type will be dependent upon the model implementation.
      .google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetadata in interface PredictResponseOrBuilder
      Returns:
      The metadata.

    • getMetadataOrBuilder

      public com.google.protobuf.ValueOrBuilder getMetadataOrBuilder()
       Output only. Request-level metadata returned by the model. The metadata
 type will be dependent upon the model implementation.
      .google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetadataOrBuilder in interface PredictResponseOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static PredictResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static PredictResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PredictResponse.Builder newBuilder()

    • newBuilder

      public static PredictResponse.Builder newBuilder(PredictResponse prototype)

    • toBuilder

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

    • newBuilderForType

      protected PredictResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PredictResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<PredictResponse> 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.GeneratedMessage

    • getDefaultInstanceForType

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