com.google.cloud.aiplatform.v1beta1

Class ExplainResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.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.v1beta1.PredictionService.Explain].
 

Protobuf type google.cloud.aiplatform.v1beta1.ExplainResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExplainResponse.Builder Response message for [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
static class	ExplainResponse.ConcurrentExplanation This message is a wrapper grouping Concurrent Explanations.
static interface	ExplainResponse.ConcurrentExplanationOrBuilder

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 and Description
static int	CONCURRENT_EXPLANATIONS_FIELD_NUMBER
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

Method Summary

Modifier and Type	Method and Description
boolean	containsConcurrentExplanations(String key) This field stores the results of the explanations run in parallel with The default explanation strategy/method.
boolean	equals(Object obj)
Map<String,ExplainResponse.ConcurrentExplanation>	getConcurrentExplanations() Deprecated.
int	getConcurrentExplanationsCount() This field stores the results of the explanations run in parallel with The default explanation strategy/method.
Map<String,ExplainResponse.ConcurrentExplanation>	getConcurrentExplanationsMap() This field stores the results of the explanations run in parallel with The default explanation strategy/method.
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.
ExplainResponse.ConcurrentExplanation	getConcurrentExplanationsOrThrow(String key) This field stores the results of the explanations run in parallel with The default explanation strategy/method.
static ExplainResponse	getDefaultInstance()
ExplainResponse	getDefaultInstanceForType()
String	getDeployedModelId() ID of the Endpoint's DeployedModel that served this explanation.
com.google.protobuf.ByteString	getDeployedModelIdBytes() ID of the Endpoint's DeployedModel that served this explanation.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Explanation	getExplanations(int index) The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
int	getExplanationsCount() The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
List<Explanation>	getExplanationsList() The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
ExplanationOrBuilder	getExplanationsOrBuilder(int index) The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
List<? extends ExplanationOrBuilder>	getExplanationsOrBuilderList() The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].
com.google.protobuf.Parser<ExplainResponse>	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()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static ExplainResponse.Builder	newBuilder()
static ExplainResponse.Builder	newBuilder(ExplainResponse prototype)
ExplainResponse.Builder	newBuilderForType()
protected ExplainResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExplainResponse	parseDelimitedFrom(InputStream input)
static ExplainResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplainResponse	parseFrom(byte[] data)
static ExplainResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplainResponse	parseFrom(ByteBuffer data)
static ExplainResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplainResponse	parseFrom(com.google.protobuf.ByteString data)
static ExplainResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplainResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static ExplainResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplainResponse	parseFrom(InputStream input)
static ExplainResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExplainResponse>	parser()
ExplainResponse.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

EXPLANATIONS_FIELD_NUMBER

public static final int EXPLANATIONS_FIELD_NUMBER

See Also:

Constant Field Values

CONCURRENT_EXPLANATIONS_FIELD_NUMBER

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

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

getExplanationsList

public List<Explanation> getExplanationsList()

 The explanations of the Model's
 [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].

 It has the same number of elements as
 [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to be
 explained.
 

repeated .google.cloud.aiplatform.v1beta1.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.v1beta1.PredictResponse.predictions].

 It has the same number of elements as
 [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to be
 explained.
 

repeated .google.cloud.aiplatform.v1beta1.Explanation explanations = 1;

Specified by:

getExplanationsOrBuilderList in interface ExplainResponseOrBuilder

getExplanationsCount

public int getExplanationsCount()

 The explanations of the Model's
 [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions].

 It has the same number of elements as
 [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to be
 explained.
 

repeated .google.cloud.aiplatform.v1beta1.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.v1beta1.PredictResponse.predictions].

 It has the same number of elements as
 [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to be
 explained.
 

repeated .google.cloud.aiplatform.v1beta1.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.v1beta1.PredictResponse.predictions].

 It has the same number of elements as
 [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to be
 explained.
 

repeated .google.cloud.aiplatform.v1beta1.Explanation explanations = 1;

Specified by:

getExplanationsOrBuilder in interface ExplainResponseOrBuilder

getConcurrentExplanationsCount

public int getConcurrentExplanationsCount()

Description copied from interface: ExplainResponseOrBuilder

 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;

Specified by:

getConcurrentExplanationsCount in interface ExplainResponseOrBuilder

containsConcurrentExplanations

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;

Specified by:

containsConcurrentExplanations in interface ExplainResponseOrBuilder

getConcurrentExplanations

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

Deprecated.

Use getConcurrentExplanationsMap() instead.

Specified by:

getConcurrentExplanations in interface ExplainResponseOrBuilder

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;

Specified by:

getConcurrentExplanationsMap in interface ExplainResponseOrBuilder

getConcurrentExplanationsOrDefault

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;

Specified by:

getConcurrentExplanationsOrDefault in interface ExplainResponseOrBuilder

getConcurrentExplanationsOrThrow

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;

Specified by:

getConcurrentExplanationsOrThrow 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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ExplainResponse parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static ExplainResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

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

newBuilder

public static ExplainResponse.Builder newBuilder()

newBuilder

public static ExplainResponse.Builder newBuilder(ExplainResponse prototype)

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

getDefaultInstance

public static ExplainResponse getDefaultInstance()

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