Class ExplainResponse.Builder (3.31.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
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1beta1.Explanation>
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.protobuf.Value>
Returns
TypeDescription
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
NameDescription
valueExplanation
Returns
TypeDescription
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
NameDescription
builderForValueExplanation.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueExplanation
Returns
TypeDescription
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
NameDescription
indexint
builderForValueExplanation.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueValue
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
indexint
valueValue
Returns
TypeDescription
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
NameDescription
indexint
builderForValueBuilder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExplainResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExplainResponse.Builder
Overrides

build()

public ExplainResponse build()
Returns
TypeDescription
ExplainResponse

buildPartial()

public ExplainResponse buildPartial()
Returns
TypeDescription
ExplainResponse

clear()

public ExplainResponse.Builder clear()
Returns
TypeDescription
ExplainResponse.Builder
Overrides

clearConcurrentExplanations()

public ExplainResponse.Builder clearConcurrentExplanations()
Returns
TypeDescription
ExplainResponse.Builder

clearDeployedModelId()

public ExplainResponse.Builder clearDeployedModelId()

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

string deployed_model_id = 2;

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

clearField(Descriptors.FieldDescriptor field)

public ExplainResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExplainResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExplainResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
ExplainResponse.Builder

clone()

public ExplainResponse.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getConcurrentExplanations()

public Map<String,ExplainResponse.ConcurrentExplanation> getConcurrentExplanations()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueExplainResponse.ConcurrentExplanation
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
ExplainResponse.ConcurrentExplanation

getDefaultInstanceForType()

public ExplainResponse getDefaultInstanceForType()
Returns
TypeDescription
ExplainResponse

getDeployedModelId()

public String getDeployedModelId()

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

string deployed_model_id = 2;

Returns
TypeDescription
String

The deployedModelId.

getDeployedModelIdBytes()

public ByteString getDeployedModelIdBytes()

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

string deployed_model_id = 2;

Returns
TypeDescription
ByteString

The bytes for deployedModelId.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.ExplanationOrBuilder>

getMutableConcurrentExplanations()

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

Use alternate mutation accessors instead.

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.protobuf.ValueOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ExplainResponse other)

public ExplainResponse.Builder mergeFrom(ExplainResponse other)
Parameter
NameDescription
otherExplainResponse
Returns
TypeDescription
ExplainResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExplainResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainResponse.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExplainResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExplainResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExplainResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,ConcurrentExplanation>
Returns
TypeDescription
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
NameDescription
keyString
valueExplainResponse.ConcurrentExplanation
Returns
TypeDescription
ExplainResponse.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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueString

The deployedModelId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for deployedModelId to set.

Returns
TypeDescription
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
NameDescription
indexint
valueExplanation
Returns
TypeDescription
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
NameDescription
indexint
builderForValueExplanation.Builder
Returns
TypeDescription
ExplainResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExplainResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
indexint
valueValue
Returns
TypeDescription
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
NameDescription
indexint
builderForValueBuilder
Returns
TypeDescription
ExplainResponse.Builder

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

public ExplainResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExplainResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExplainResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExplainResponse.Builder
Overrides