Class ExplainResponse (1.5.0)

public final class ExplainResponse extends GeneratedMessageV3 implements ExplainResponseOrBuilder

Response message for PredictionService.Explain.

Protobuf type google.cloud.vertexai.v1.ExplainResponse

Static Fields

DEPLOYED_MODEL_ID_FIELD_NUMBER

public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
Field Value
Type Description
int

EXPLANATIONS_FIELD_NUMBER

public static final int EXPLANATIONS_FIELD_NUMBER
Field Value
Type Description
int

PREDICTIONS_FIELD_NUMBER

public static final int PREDICTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExplainResponse getDefaultInstance()
Returns
Type Description
ExplainResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExplainResponse.Builder newBuilder()
Returns
Type Description
ExplainResponse.Builder

newBuilder(ExplainResponse prototype)

public static ExplainResponse.Builder newBuilder(ExplainResponse prototype)
Parameter
Name Description
prototype ExplainResponse
Returns
Type Description
ExplainResponse.Builder

parseDelimitedFrom(InputStream input)

public static ExplainResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExplainResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplainResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplainResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplainResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExplainResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExplainResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplainResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExplainResponse> parser()
Returns
Type Description
Parser<ExplainResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ExplainResponse getDefaultInstanceForType()
Returns
Type Description
ExplainResponse

getDeployedModelId()

public String getDeployedModelId()

ID of the Endpoint's DeployedModel that served this explanation.

string deployed_model_id = 2;

Returns
Type Description
String

The deployedModelId.

getDeployedModelIdBytes()

public ByteString getDeployedModelIdBytes()

ID of the Endpoint's DeployedModel that served this explanation.

string deployed_model_id = 2;

Returns
Type Description
ByteString

The bytes for deployedModelId.

getExplanations(int index)

public Explanation getExplanations(int index)

The explanations of the Model's PredictResponse.predictions.

It has the same number of elements as instances to be explained.

repeated .google.cloud.vertexai.v1.Explanation explanations = 1;

Parameter
Name Description
index int
Returns
Type Description
Explanation

getExplanationsCount()

public int getExplanationsCount()

The explanations of the Model's PredictResponse.predictions.

It has the same number of elements as instances to be explained.

repeated .google.cloud.vertexai.v1.Explanation explanations = 1;

Returns
Type Description
int

getExplanationsList()

public List<Explanation> getExplanationsList()

The explanations of the Model's PredictResponse.predictions.

It has the same number of elements as instances to be explained.

repeated .google.cloud.vertexai.v1.Explanation explanations = 1;

Returns
Type Description
List<Explanation>

getExplanationsOrBuilder(int index)

public ExplanationOrBuilder getExplanationsOrBuilder(int index)

The explanations of the Model's PredictResponse.predictions.

It has the same number of elements as instances to be explained.

repeated .google.cloud.vertexai.v1.Explanation explanations = 1;

Parameter
Name Description
index int
Returns
Type Description
ExplanationOrBuilder

getExplanationsOrBuilderList()

public List<? extends ExplanationOrBuilder> getExplanationsOrBuilderList()

The explanations of the Model's PredictResponse.predictions.

It has the same number of elements as instances to be explained.

repeated .google.cloud.vertexai.v1.Explanation explanations = 1;

Returns
Type Description
List<? extends com.google.cloud.vertexai.api.ExplanationOrBuilder>

getParserForType()

public Parser<ExplainResponse> getParserForType()
Returns
Type Description
Parser<ExplainResponse>
Overrides

getPredictions(int index)

public Value getPredictions(int index)

The predictions that are the output of the predictions call. Same as PredictResponse.predictions.

repeated .google.protobuf.Value predictions = 3;

Parameter
Name Description
index int
Returns
Type Description
Value

getPredictionsCount()

public int getPredictionsCount()

The predictions that are the output of the predictions call. Same as PredictResponse.predictions.

repeated .google.protobuf.Value predictions = 3;

Returns
Type Description
int

getPredictionsList()

public List<Value> getPredictionsList()

The predictions that are the output of the predictions call. Same as PredictResponse.predictions.

repeated .google.protobuf.Value predictions = 3;

Returns
Type Description
List<Value>

getPredictionsOrBuilder(int index)

public ValueOrBuilder getPredictionsOrBuilder(int index)

The predictions that are the output of the predictions call. Same as PredictResponse.predictions.

repeated .google.protobuf.Value predictions = 3;

Parameter
Name Description
index int
Returns
Type Description
ValueOrBuilder

getPredictionsOrBuilderList()

public List<? extends ValueOrBuilder> getPredictionsOrBuilderList()

The predictions that are the output of the predictions call. Same as PredictResponse.predictions.

repeated .google.protobuf.Value predictions = 3;

Returns
Type Description
List<? extends com.google.protobuf.ValueOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExplainResponse.Builder newBuilderForType()
Returns
Type Description
ExplainResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplainResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExplainResponse.Builder toBuilder()
Returns
Type Description
ExplainResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException