Class ExplainResponse

  • All Implemented Interfaces:
    ExplainResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ExplainResponse
    extends com.google.protobuf.GeneratedMessageV3
    implements ExplainResponseOrBuilder
     Response message for
     [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
     
    Protobuf type google.cloud.aiplatform.v1.ExplainResponse
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExplainResponse.Builder
      Response message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEPLOYED_MODEL_ID_FIELD_NUMBER  
      static int EXPLANATIONS_FIELD_NUMBER  
      static int PREDICTIONS_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Field Detail

      • EXPLANATIONS_FIELD_NUMBER

        public static final int EXPLANATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DEPLOYED_MODEL_ID_FIELD_NUMBER

        public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PREDICTIONS_FIELD_NUMBER

        public static final int PREDICTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • 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()
      • internalGetFieldAccessorTable

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

        public List<Explanation> getExplanationsList()
         The explanations of the Model's
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
        
         It has the same number of elements as
         [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be
         explained.
         
        repeated .google.cloud.aiplatform.v1.Explanation explanations = 1;
        Specified by:
        getExplanationsList in interface ExplainResponseOrBuilder
      • getExplanationsOrBuilderList

        public List<? extends ExplanationOrBuilder> getExplanationsOrBuilderList()
         The explanations of the Model's
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
        
         It has the same number of elements as
         [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be
         explained.
         
        repeated .google.cloud.aiplatform.v1.Explanation explanations = 1;
        Specified by:
        getExplanationsOrBuilderList in interface ExplainResponseOrBuilder
      • getExplanationsCount

        public int getExplanationsCount()
         The explanations of the Model's
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
        
         It has the same number of elements as
         [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be
         explained.
         
        repeated .google.cloud.aiplatform.v1.Explanation explanations = 1;
        Specified by:
        getExplanationsCount in interface ExplainResponseOrBuilder
      • getExplanations

        public Explanation getExplanations​(int index)
         The explanations of the Model's
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
        
         It has the same number of elements as
         [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be
         explained.
         
        repeated .google.cloud.aiplatform.v1.Explanation explanations = 1;
        Specified by:
        getExplanations in interface ExplainResponseOrBuilder
      • getExplanationsOrBuilder

        public ExplanationOrBuilder getExplanationsOrBuilder​(int index)
         The explanations of the Model's
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
        
         It has the same number of elements as
         [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be
         explained.
         
        repeated .google.cloud.aiplatform.v1.Explanation explanations = 1;
        Specified by:
        getExplanationsOrBuilder in interface ExplainResponseOrBuilder
      • getDeployedModelId

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

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

        public List<com.google.protobuf.Value> getPredictionsList()
         The predictions that are the output of the predictions call.
         Same as
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
         
        repeated .google.protobuf.Value predictions = 3;
        Specified by:
        getPredictionsList in interface ExplainResponseOrBuilder
      • getPredictionsOrBuilderList

        public List<? extends com.google.protobuf.ValueOrBuilder> getPredictionsOrBuilderList()
         The predictions that are the output of the predictions call.
         Same as
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
         
        repeated .google.protobuf.Value predictions = 3;
        Specified by:
        getPredictionsOrBuilderList in interface ExplainResponseOrBuilder
      • getPredictionsCount

        public int getPredictionsCount()
         The predictions that are the output of the predictions call.
         Same as
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
         
        repeated .google.protobuf.Value predictions = 3;
        Specified by:
        getPredictionsCount in interface ExplainResponseOrBuilder
      • getPredictions

        public com.google.protobuf.Value getPredictions​(int index)
         The predictions that are the output of the predictions call.
         Same as
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
         
        repeated .google.protobuf.Value predictions = 3;
        Specified by:
        getPredictions in interface ExplainResponseOrBuilder
      • getPredictionsOrBuilder

        public com.google.protobuf.ValueOrBuilder getPredictionsOrBuilder​(int index)
         The predictions that are the output of the predictions call.
         Same as
         [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions].
         
        repeated .google.protobuf.Value predictions = 3;
        Specified by:
        getPredictionsOrBuilder in interface ExplainResponseOrBuilder
      • 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 ExplainResponse parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static ExplainResponse parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static ExplainResponse parseFrom​(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected ExplainResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • parser

        public static com.google.protobuf.Parser<ExplainResponse> parser()
      • getParserForType

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