Class ExplainResponse.Builder (3.43.0)

public static final class ExplainResponse.Builder extends GeneratedMessageV3.Builder<ExplainResponse.Builder> implements ExplainResponseOrBuilder

Response message for PredictionService.Explain.

Protobuf type google.cloud.aiplatform.v1beta1.ExplainResponse

Static Methods

getDescriptor()

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

Methods

addAllExplanations(Iterable<? extends Explanation> values)

public ExplainResponse.Builder addAllExplanations(Iterable<? extends Explanation> values)

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
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.Explanation>
Returns
Type Description
ExplainResponse.Builder

addAllPredictions(Iterable<? extends Value> values)

public ExplainResponse.Builder addAllPredictions(Iterable<? extends Value> values)

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

repeated .google.protobuf.Value predictions = 3;

Parameter
Name Description
values Iterable<? extends com.google.protobuf.Value>
Returns
Type Description
ExplainResponse.Builder

addExplanations(Explanation value)

public ExplainResponse.Builder addExplanations(Explanation value)

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
value Explanation
Returns
Type Description
ExplainResponse.Builder

addExplanations(Explanation.Builder builderForValue)

public ExplainResponse.Builder addExplanations(Explanation.Builder builderForValue)

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
builderForValue Explanation.Builder
Returns
Type Description
ExplainResponse.Builder

addExplanations(int index, Explanation value)

public ExplainResponse.Builder addExplanations(int index, Explanation value)

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;

Parameters
Name Description
index int
value Explanation
Returns
Type Description
ExplainResponse.Builder

addExplanations(int index, Explanation.Builder builderForValue)

public ExplainResponse.Builder addExplanations(int index, Explanation.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Explanation.Builder
Returns
Type Description
ExplainResponse.Builder

addExplanationsBuilder()

public Explanation.Builder addExplanationsBuilder()

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
Explanation.Builder

addExplanationsBuilder(int index)

public Explanation.Builder addExplanationsBuilder(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.Builder

addPredictions(Value value)

public ExplainResponse.Builder addPredictions(Value value)

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

repeated .google.protobuf.Value predictions = 3;

Parameter
Name Description
value Value
Returns
Type Description
ExplainResponse.Builder

addPredictions(Value.Builder builderForValue)

public ExplainResponse.Builder addPredictions(Value.Builder builderForValue)

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

repeated .google.protobuf.Value predictions = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExplainResponse.Builder

addPredictions(int index, Value value)

public ExplainResponse.Builder addPredictions(int index, Value value)

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

repeated .google.protobuf.Value predictions = 3;

Parameters
Name Description
index int
value Value
Returns
Type Description
ExplainResponse.Builder

addPredictions(int index, Value.Builder builderForValue)

public ExplainResponse.Builder addPredictions(int index, Value.Builder builderForValue)

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

repeated .google.protobuf.Value predictions = 3;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
ExplainResponse.Builder

addPredictionsBuilder()

public Value.Builder addPredictionsBuilder()

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

repeated .google.protobuf.Value predictions = 3;

Returns
Type Description
Builder

addPredictionsBuilder(int index)

public Value.Builder addPredictionsBuilder(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
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExplainResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExplainResponse.Builder
Overrides

build()

public ExplainResponse build()
Returns
Type Description
ExplainResponse

buildPartial()

public ExplainResponse buildPartial()
Returns
Type Description
ExplainResponse

clear()

public ExplainResponse.Builder clear()
Returns
Type Description
ExplainResponse.Builder
Overrides

clearConcurrentExplanations()

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

clearDeployedModelId()

public ExplainResponse.Builder clearDeployedModelId()

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

string deployed_model_id = 2;

Returns
Type Description
ExplainResponse.Builder

This builder for chaining.

clearExplanations()

public ExplainResponse.Builder clearExplanations()

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
ExplainResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ExplainResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExplainResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExplainResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExplainResponse.Builder
Overrides

clearPredictions()

public ExplainResponse.Builder clearPredictions()

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

repeated .google.protobuf.Value predictions = 3;

Returns
Type Description
ExplainResponse.Builder

clone()

public ExplainResponse.Builder clone()
Returns
Type Description
ExplainResponse.Builder
Overrides

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

getConcurrentExplanations() (deprecated)

public Map<String,ExplainResponse.ConcurrentExplanation> getConcurrentExplanations()
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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getExplanationsBuilder(int index)

public Explanation.Builder getExplanationsBuilder(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.Builder

getExplanationsBuilderList()

public List<Explanation.Builder> getExplanationsBuilderList()

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<Builder>

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>

getMutableConcurrentExplanations() (deprecated)

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

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,ConcurrentExplanation>

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

getPredictionsBuilder(int index)

public Value.Builder getPredictionsBuilder(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
Builder

getPredictionsBuilderList()

public List<Value.Builder> getPredictionsBuilderList()

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

repeated .google.protobuf.Value predictions = 3;

Returns
Type Description
List<Builder>

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>

internalGetFieldAccessorTable()

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

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExplainResponse other)

public ExplainResponse.Builder mergeFrom(ExplainResponse other)
Parameter
Name Description
other ExplainResponse
Returns
Type Description
ExplainResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExplainResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExplainResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExplainResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExplainResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExplainResponse.Builder
Overrides

putAllConcurrentExplanations(Map<String,ExplainResponse.ConcurrentExplanation> values)

public ExplainResponse.Builder putAllConcurrentExplanations(Map<String,ExplainResponse.ConcurrentExplanation> values)

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
values Map<String,ConcurrentExplanation>
Returns
Type Description
ExplainResponse.Builder

putConcurrentExplanations(String key, ExplainResponse.ConcurrentExplanation value)

public ExplainResponse.Builder putConcurrentExplanations(String key, ExplainResponse.ConcurrentExplanation value)

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
value ExplainResponse.ConcurrentExplanation
Returns
Type Description
ExplainResponse.Builder

putConcurrentExplanationsBuilderIfAbsent(String key)

public ExplainResponse.ConcurrentExplanation.Builder putConcurrentExplanationsBuilderIfAbsent(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.Builder

removeConcurrentExplanations(String key)

public ExplainResponse.Builder removeConcurrentExplanations(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.Builder

removeExplanations(int index)

public ExplainResponse.Builder removeExplanations(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
ExplainResponse.Builder

removePredictions(int index)

public ExplainResponse.Builder removePredictions(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
ExplainResponse.Builder

setDeployedModelId(String value)

public ExplainResponse.Builder setDeployedModelId(String value)

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

string deployed_model_id = 2;

Parameter
Name Description
value String

The deployedModelId to set.

Returns
Type Description
ExplainResponse.Builder

This builder for chaining.

setDeployedModelIdBytes(ByteString value)

public ExplainResponse.Builder setDeployedModelIdBytes(ByteString value)

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

string deployed_model_id = 2;

Parameter
Name Description
value ByteString

The bytes for deployedModelId to set.

Returns
Type Description
ExplainResponse.Builder

This builder for chaining.

setExplanations(int index, Explanation value)

public ExplainResponse.Builder setExplanations(int index, Explanation value)

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;

Parameters
Name Description
index int
value Explanation
Returns
Type Description
ExplainResponse.Builder

setExplanations(int index, Explanation.Builder builderForValue)

public ExplainResponse.Builder setExplanations(int index, Explanation.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Explanation.Builder
Returns
Type Description
ExplainResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExplainResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExplainResponse.Builder
Overrides

setPredictions(int index, Value value)

public ExplainResponse.Builder setPredictions(int index, Value value)

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

repeated .google.protobuf.Value predictions = 3;

Parameters
Name Description
index int
value Value
Returns
Type Description
ExplainResponse.Builder

setPredictions(int index, Value.Builder builderForValue)

public ExplainResponse.Builder setPredictions(int index, Value.Builder builderForValue)

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

repeated .google.protobuf.Value predictions = 3;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
ExplainResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExplainResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExplainResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExplainResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExplainResponse.Builder
Overrides