com.google.cloud.aiplatform.v1

Class ExplainRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

com.google.cloud.aiplatform.v1.ExplainRequest.Builder

All Implemented Interfaces:

ExplainRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ExplainRequest

public static final class ExplainRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>
implements ExplainRequestOrBuilder

 Request message for
 [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
 

Protobuf type google.cloud.aiplatform.v1.ExplainRequest

Method Summary

Modifier and Type	Method and Description
ExplainRequest.Builder	addAllInstances(Iterable<? extends com.google.protobuf.Value> values) Required.
ExplainRequest.Builder	addInstances(int index, com.google.protobuf.Value.Builder builderForValue) Required.
ExplainRequest.Builder	addInstances(int index, com.google.protobuf.Value value) Required.
ExplainRequest.Builder	addInstances(com.google.protobuf.Value.Builder builderForValue) Required.
ExplainRequest.Builder	addInstances(com.google.protobuf.Value value) Required.
com.google.protobuf.Value.Builder	addInstancesBuilder() Required.
com.google.protobuf.Value.Builder	addInstancesBuilder(int index) Required.
ExplainRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExplainRequest	build()
ExplainRequest	buildPartial()
ExplainRequest.Builder	clear()
ExplainRequest.Builder	clearDeployedModelId() If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
ExplainRequest.Builder	clearEndpoint() Required.
ExplainRequest.Builder	clearExplanationSpecOverride() If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
ExplainRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ExplainRequest.Builder	clearInstances() Required.
ExplainRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ExplainRequest.Builder	clearParameters() The parameters that govern the prediction.
ExplainRequest.Builder	clone()
ExplainRequest	getDefaultInstanceForType()
String	getDeployedModelId() If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
com.google.protobuf.ByteString	getDeployedModelIdBytes() If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getEndpoint() Required.
com.google.protobuf.ByteString	getEndpointBytes() Required.
ExplanationSpecOverride	getExplanationSpecOverride() If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
ExplanationSpecOverride.Builder	getExplanationSpecOverrideBuilder() If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
ExplanationSpecOverrideOrBuilder	getExplanationSpecOverrideOrBuilder() If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
com.google.protobuf.Value	getInstances(int index) Required.
com.google.protobuf.Value.Builder	getInstancesBuilder(int index) Required.
List<com.google.protobuf.Value.Builder>	getInstancesBuilderList() Required.
int	getInstancesCount() Required.
List<com.google.protobuf.Value>	getInstancesList() Required.
com.google.protobuf.ValueOrBuilder	getInstancesOrBuilder(int index) Required.
List<? extends com.google.protobuf.ValueOrBuilder>	getInstancesOrBuilderList() Required.
com.google.protobuf.Value	getParameters() The parameters that govern the prediction.
com.google.protobuf.Value.Builder	getParametersBuilder() The parameters that govern the prediction.
com.google.protobuf.ValueOrBuilder	getParametersOrBuilder() The parameters that govern the prediction.
boolean	hasExplanationSpecOverride() If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
boolean	hasParameters() The parameters that govern the prediction.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ExplainRequest.Builder	mergeExplanationSpecOverride(ExplanationSpecOverride value) If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
ExplainRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ExplainRequest.Builder	mergeFrom(ExplainRequest other)
ExplainRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ExplainRequest.Builder	mergeParameters(com.google.protobuf.Value value) The parameters that govern the prediction.
ExplainRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ExplainRequest.Builder	removeInstances(int index) Required.
ExplainRequest.Builder	setDeployedModelId(String value) If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
ExplainRequest.Builder	setDeployedModelIdBytes(com.google.protobuf.ByteString value) If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
ExplainRequest.Builder	setEndpoint(String value) Required.
ExplainRequest.Builder	setEndpointBytes(com.google.protobuf.ByteString value) Required.
ExplainRequest.Builder	setExplanationSpecOverride(ExplanationSpecOverride.Builder builderForValue) If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
ExplainRequest.Builder	setExplanationSpecOverride(ExplanationSpecOverride value) If specified, overrides the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel.
ExplainRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExplainRequest.Builder	setInstances(int index, com.google.protobuf.Value.Builder builderForValue) Required.
ExplainRequest.Builder	setInstances(int index, com.google.protobuf.Value value) Required.
ExplainRequest.Builder	setParameters(com.google.protobuf.Value.Builder builderForValue) The parameters that govern the prediction.
ExplainRequest.Builder	setParameters(com.google.protobuf.Value value) The parameters that govern the prediction.
ExplainRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ExplainRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

clear

public ExplainRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

getDefaultInstanceForType

public ExplainRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ExplainRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ExplainRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ExplainRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

setField

public ExplainRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

clearField

public ExplainRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

clearOneof

public ExplainRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

setRepeatedField

public ExplainRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

addRepeatedField

public ExplainRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

mergeFrom

public ExplainRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExplainRequest.Builder>

mergeFrom

public ExplainRequest.Builder mergeFrom(ExplainRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

mergeFrom

public ExplainRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExplainRequest.Builder>

Throws:

IOException

getEndpoint

public String getEndpoint()

 Required. The name of the Endpoint requested to serve the explanation.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
 

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getEndpoint in interface ExplainRequestOrBuilder

Returns:

The endpoint.

getEndpointBytes

public com.google.protobuf.ByteString getEndpointBytes()

 Required. The name of the Endpoint requested to serve the explanation.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
 

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getEndpointBytes in interface ExplainRequestOrBuilder

Returns:

The bytes for endpoint.

setEndpoint

public ExplainRequest.Builder setEndpoint(String value)

 Required. The name of the Endpoint requested to serve the explanation.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
 

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The endpoint to set.

Returns:

This builder for chaining.

clearEndpoint

public ExplainRequest.Builder clearEndpoint()

 Required. The name of the Endpoint requested to serve the explanation.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
 

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

This builder for chaining.

setEndpointBytes

public ExplainRequest.Builder setEndpointBytes(com.google.protobuf.ByteString value)

 Required. The name of the Endpoint requested to serve the explanation.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
 

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The bytes for endpoint to set.

Returns:

This builder for chaining.

getInstancesList

public List<com.google.protobuf.Value> getInstancesList()

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstancesList in interface ExplainRequestOrBuilder

getInstancesCount

public int getInstancesCount()

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstancesCount in interface ExplainRequestOrBuilder

getInstances

public com.google.protobuf.Value getInstances(int index)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstances in interface ExplainRequestOrBuilder

setInstances

public ExplainRequest.Builder setInstances(int index,
                                           com.google.protobuf.Value value)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

setInstances

public ExplainRequest.Builder setInstances(int index,
                                           com.google.protobuf.Value.Builder builderForValue)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

addInstances

public ExplainRequest.Builder addInstances(com.google.protobuf.Value value)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

addInstances

public ExplainRequest.Builder addInstances(int index,
                                           com.google.protobuf.Value value)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

addInstances

public ExplainRequest.Builder addInstances(com.google.protobuf.Value.Builder builderForValue)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

addInstances

public ExplainRequest.Builder addInstances(int index,
                                           com.google.protobuf.Value.Builder builderForValue)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

addAllInstances

public ExplainRequest.Builder addAllInstances(Iterable<? extends com.google.protobuf.Value> values)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

clearInstances

public ExplainRequest.Builder clearInstances()

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

removeInstances

public ExplainRequest.Builder removeInstances(int index)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

getInstancesBuilder

public com.google.protobuf.Value.Builder getInstancesBuilder(int index)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

getInstancesOrBuilder

public com.google.protobuf.ValueOrBuilder getInstancesOrBuilder(int index)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstancesOrBuilder in interface ExplainRequestOrBuilder

getInstancesOrBuilderList

public List<? extends com.google.protobuf.ValueOrBuilder> getInstancesOrBuilderList()

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstancesOrBuilderList in interface ExplainRequestOrBuilder

addInstancesBuilder

public com.google.protobuf.Value.Builder addInstancesBuilder()

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

addInstancesBuilder

public com.google.protobuf.Value.Builder addInstancesBuilder(int index)

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

getInstancesBuilderList

public List<com.google.protobuf.Value.Builder> getInstancesBuilderList()

 Required. The instances that are the input to the explanation call.
 A DeployedModel may have an upper limit on the number of instances it
 supports per request, and when it is exceeded the explanation call errors
 in case of AutoML Models, or, in case of customer created Models, the
 behaviour is as documented by that Model.
 The schema of any single instance may be specified via Endpoint's
 DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

hasParameters

public boolean hasParameters()

 The parameters that govern the prediction. The schema of the parameters may
 be specified via Endpoint's DeployedModels' [Model's
 ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 4;

Specified by:

hasParameters in interface ExplainRequestOrBuilder

Returns:

Whether the parameters field is set.

getParameters

public com.google.protobuf.Value getParameters()

 The parameters that govern the prediction. The schema of the parameters may
 be specified via Endpoint's DeployedModels' [Model's
 ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 4;

Specified by:

getParameters in interface ExplainRequestOrBuilder

Returns:

The parameters.

setParameters

public ExplainRequest.Builder setParameters(com.google.protobuf.Value value)

 The parameters that govern the prediction. The schema of the parameters may
 be specified via Endpoint's DeployedModels' [Model's
 ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 4;

setParameters

public ExplainRequest.Builder setParameters(com.google.protobuf.Value.Builder builderForValue)

 The parameters that govern the prediction. The schema of the parameters may
 be specified via Endpoint's DeployedModels' [Model's
 ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 4;

mergeParameters

public ExplainRequest.Builder mergeParameters(com.google.protobuf.Value value)

 The parameters that govern the prediction. The schema of the parameters may
 be specified via Endpoint's DeployedModels' [Model's
 ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 4;

clearParameters

public ExplainRequest.Builder clearParameters()

 The parameters that govern the prediction. The schema of the parameters may
 be specified via Endpoint's DeployedModels' [Model's
 ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 4;

getParametersBuilder

public com.google.protobuf.Value.Builder getParametersBuilder()

 The parameters that govern the prediction. The schema of the parameters may
 be specified via Endpoint's DeployedModels' [Model's
 ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 4;

getParametersOrBuilder

public com.google.protobuf.ValueOrBuilder getParametersOrBuilder()

 The parameters that govern the prediction. The schema of the parameters may
 be specified via Endpoint's DeployedModels' [Model's
 ][google.cloud.aiplatform.v1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 4;

Specified by:

getParametersOrBuilder in interface ExplainRequestOrBuilder

hasExplanationSpecOverride

public boolean hasExplanationSpecOverride()

 If specified, overrides the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 of the DeployedModel. Can be used for explaining prediction results with
 different configurations, such as:
  - Explaining top-5 predictions results as opposed to top-1;
  - Increasing path count or step count of the attribution methods to reduce
    approximate errors;
  - Using different baselines for explaining the prediction results.
 

.google.cloud.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;

Specified by:

hasExplanationSpecOverride in interface ExplainRequestOrBuilder

Returns:

Whether the explanationSpecOverride field is set.

getExplanationSpecOverride

public ExplanationSpecOverride getExplanationSpecOverride()

 If specified, overrides the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 of the DeployedModel. Can be used for explaining prediction results with
 different configurations, such as:
  - Explaining top-5 predictions results as opposed to top-1;
  - Increasing path count or step count of the attribution methods to reduce
    approximate errors;
  - Using different baselines for explaining the prediction results.
 

.google.cloud.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;

Specified by:

getExplanationSpecOverride in interface ExplainRequestOrBuilder

Returns:

The explanationSpecOverride.

setExplanationSpecOverride

public ExplainRequest.Builder setExplanationSpecOverride(ExplanationSpecOverride value)

 If specified, overrides the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 of the DeployedModel. Can be used for explaining prediction results with
 different configurations, such as:
  - Explaining top-5 predictions results as opposed to top-1;
  - Increasing path count or step count of the attribution methods to reduce
    approximate errors;
  - Using different baselines for explaining the prediction results.
 

.google.cloud.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;

setExplanationSpecOverride

public ExplainRequest.Builder setExplanationSpecOverride(ExplanationSpecOverride.Builder builderForValue)

 If specified, overrides the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 of the DeployedModel. Can be used for explaining prediction results with
 different configurations, such as:
  - Explaining top-5 predictions results as opposed to top-1;
  - Increasing path count or step count of the attribution methods to reduce
    approximate errors;
  - Using different baselines for explaining the prediction results.
 

.google.cloud.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;

mergeExplanationSpecOverride

public ExplainRequest.Builder mergeExplanationSpecOverride(ExplanationSpecOverride value)

 If specified, overrides the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 of the DeployedModel. Can be used for explaining prediction results with
 different configurations, such as:
  - Explaining top-5 predictions results as opposed to top-1;
  - Increasing path count or step count of the attribution methods to reduce
    approximate errors;
  - Using different baselines for explaining the prediction results.
 

.google.cloud.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;

clearExplanationSpecOverride

public ExplainRequest.Builder clearExplanationSpecOverride()

 If specified, overrides the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 of the DeployedModel. Can be used for explaining prediction results with
 different configurations, such as:
  - Explaining top-5 predictions results as opposed to top-1;
  - Increasing path count or step count of the attribution methods to reduce
    approximate errors;
  - Using different baselines for explaining the prediction results.
 

.google.cloud.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;

getExplanationSpecOverrideBuilder

public ExplanationSpecOverride.Builder getExplanationSpecOverrideBuilder()

 If specified, overrides the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 of the DeployedModel. Can be used for explaining prediction results with
 different configurations, such as:
  - Explaining top-5 predictions results as opposed to top-1;
  - Increasing path count or step count of the attribution methods to reduce
    approximate errors;
  - Using different baselines for explaining the prediction results.
 

.google.cloud.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;

getExplanationSpecOverrideOrBuilder

public ExplanationSpecOverrideOrBuilder getExplanationSpecOverrideOrBuilder()

 If specified, overrides the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 of the DeployedModel. Can be used for explaining prediction results with
 different configurations, such as:
  - Explaining top-5 predictions results as opposed to top-1;
  - Increasing path count or step count of the attribution methods to reduce
    approximate errors;
  - Using different baselines for explaining the prediction results.
 

.google.cloud.aiplatform.v1.ExplanationSpecOverride explanation_spec_override = 5;

Specified by:

getExplanationSpecOverrideOrBuilder in interface ExplainRequestOrBuilder

getDeployedModelId

public String getDeployedModelId()

 If specified, this ExplainRequest will be served by the chosen
 DeployedModel, overriding
 [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
 

string deployed_model_id = 3;

Specified by:

getDeployedModelId in interface ExplainRequestOrBuilder

Returns:

The deployedModelId.

getDeployedModelIdBytes

public com.google.protobuf.ByteString getDeployedModelIdBytes()

 If specified, this ExplainRequest will be served by the chosen
 DeployedModel, overriding
 [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
 

string deployed_model_id = 3;

Specified by:

getDeployedModelIdBytes in interface ExplainRequestOrBuilder

Returns:

The bytes for deployedModelId.

setDeployedModelId

public ExplainRequest.Builder setDeployedModelId(String value)

 If specified, this ExplainRequest will be served by the chosen
 DeployedModel, overriding
 [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
 

string deployed_model_id = 3;

Parameters:

value - The deployedModelId to set.

Returns:

This builder for chaining.

clearDeployedModelId

public ExplainRequest.Builder clearDeployedModelId()

 If specified, this ExplainRequest will be served by the chosen
 DeployedModel, overriding
 [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
 

string deployed_model_id = 3;

Returns:

This builder for chaining.

setDeployedModelIdBytes

public ExplainRequest.Builder setDeployedModelIdBytes(com.google.protobuf.ByteString value)

 If specified, this ExplainRequest will be served by the chosen
 DeployedModel, overriding
 [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split].
 

string deployed_model_id = 3;

Parameters:

value - The bytes for deployedModelId to set.

Returns:

This builder for chaining.

setUnknownFields

public final ExplainRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>

mergeUnknownFields

public final ExplainRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExplainRequest.Builder>