Class ExplainResponse (3.36.0)

public final class ExplainResponse extends GeneratedMessageV3 implements ExplainResponseOrBuilder

Response message for PredictionService.Explain.

Protobuf type google.cloud.aiplatform.v1beta1.ExplainResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExplainResponse

Implements

ExplainResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONCURRENT_EXPLANATIONS_FIELD_NUMBER

public static final int CONCURRENT_EXPLANATIONS_FIELD_NUMBER

Field Value
Type	Description
`int`

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

containsConcurrentExplanations(String key)

public boolean containsConcurrentExplanations(String key)

This field stores the results of the explanations run in parallel with The default explanation strategy/method.

map<string, .google.cloud.aiplatform.v1beta1.ExplainResponse.ConcurrentExplanation> concurrent_explanations = 4;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getConcurrentExplanations() (deprecated)

public Map<String,ExplainResponse.ConcurrentExplanation> getConcurrentExplanations()

Use #getConcurrentExplanationsMap() instead.

Returns
Type	Description
`Map<String,ConcurrentExplanation>`

getConcurrentExplanationsCount()

public int getConcurrentExplanationsCount()

This field stores the results of the explanations run in parallel with The default explanation strategy/method.

map<string, .google.cloud.aiplatform.v1beta1.ExplainResponse.ConcurrentExplanation> concurrent_explanations = 4;

Returns
Type	Description
`int`

getConcurrentExplanationsMap()

public Map<String,ExplainResponse.ConcurrentExplanation> getConcurrentExplanationsMap()

This field stores the results of the explanations run in parallel with The default explanation strategy/method.

map<string, .google.cloud.aiplatform.v1beta1.ExplainResponse.ConcurrentExplanation> concurrent_explanations = 4;

Returns
Type	Description
`Map<String,ConcurrentExplanation>`

getConcurrentExplanationsOrDefault(String key, ExplainResponse.ConcurrentExplanation defaultValue)

public ExplainResponse.ConcurrentExplanation getConcurrentExplanationsOrDefault(String key, ExplainResponse.ConcurrentExplanation defaultValue)

This field stores the results of the explanations run in parallel with The default explanation strategy/method.

map<string, .google.cloud.aiplatform.v1beta1.ExplainResponse.ConcurrentExplanation> concurrent_explanations = 4;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`ExplainResponse.ConcurrentExplanation`

Returns
Type	Description
`ExplainResponse.ConcurrentExplanation`

getConcurrentExplanationsOrThrow(String key)

public ExplainResponse.ConcurrentExplanation getConcurrentExplanationsOrThrow(String key)

This field stores the results of the explanations run in parallel with The default explanation strategy/method.

map<string, .google.cloud.aiplatform.v1beta1.ExplainResponse.ConcurrentExplanation> concurrent_explanations = 4;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`ExplainResponse.ConcurrentExplanation`

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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.Explanation explanations = 1;

Returns
Type	Description
`List<? extends com.google.cloud.aiplatform.v1beta1.ExplanationOrBuilder>`

getParserForType()

public Parser<ExplainResponse> getParserForType()

Returns
Type	Description
`Parser<ExplainResponse>`

Overrides

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ExplainResponse.Builder toBuilder()

Returns
Type	Description
`ExplainResponse.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`