Class PredictRequest.Builder (1.5.0)

public static final class PredictRequest.Builder extends GeneratedMessageV3.Builder<PredictRequest.Builder> implements PredictRequestOrBuilder

Request message for PredictionService.Predict.

Protobuf type google.cloud.vertexai.v1.PredictRequest

Static Methods

getDescriptor()

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

Methods

addAllInstances(Iterable<? extends Value> values)

public PredictRequest.Builder addAllInstances(Iterable<? extends Value> values)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

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

addInstances(Value value)

public PredictRequest.Builder addInstances(Value value)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Parameter
Name Description
value Value
Returns
Type Description
PredictRequest.Builder

addInstances(Value.Builder builderForValue)

public PredictRequest.Builder addInstances(Value.Builder builderForValue)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PredictRequest.Builder

addInstances(int index, Value value)

public PredictRequest.Builder addInstances(int index, Value value)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

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

addInstances(int index, Value.Builder builderForValue)

public PredictRequest.Builder addInstances(int index, Value.Builder builderForValue)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

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

addInstancesBuilder()

public Value.Builder addInstancesBuilder()

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Returns
Type Description
Builder

addInstancesBuilder(int index)

public Value.Builder addInstancesBuilder(int index)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Parameter
Name Description
index int
Returns
Type Description
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PredictRequest build()
Returns
Type Description
PredictRequest

buildPartial()

public PredictRequest buildPartial()
Returns
Type Description
PredictRequest

clear()

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

clearEndpoint()

public PredictRequest.Builder clearEndpoint()

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

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

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearInstances()

public PredictRequest.Builder clearInstances()

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Returns
Type Description
PredictRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParameters()

public PredictRequest.Builder clearParameters()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 3;

Returns
Type Description
PredictRequest.Builder

clone()

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

getDefaultInstanceForType()

public PredictRequest getDefaultInstanceForType()
Returns
Type Description
PredictRequest

getDescriptorForType()

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

getEndpoint()

public String getEndpoint()

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

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

Returns
Type Description
String

The endpoint.

getEndpointBytes()

public ByteString getEndpointBytes()

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

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

Returns
Type Description
ByteString

The bytes for endpoint.

getInstances(int index)

public Value getInstances(int index)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Parameter
Name Description
index int
Returns
Type Description
Value

getInstancesBuilder(int index)

public Value.Builder getInstancesBuilder(int index)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Parameter
Name Description
index int
Returns
Type Description
Builder

getInstancesBuilderList()

public List<Value.Builder> getInstancesBuilderList()

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Returns
Type Description
List<Builder>

getInstancesCount()

public int getInstancesCount()

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Returns
Type Description
int

getInstancesList()

public List<Value> getInstancesList()

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Returns
Type Description
List<Value>

getInstancesOrBuilder(int index)

public ValueOrBuilder getInstancesOrBuilder(int index)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Parameter
Name Description
index int
Returns
Type Description
ValueOrBuilder

getInstancesOrBuilderList()

public List<? extends ValueOrBuilder> getInstancesOrBuilderList()

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Returns
Type Description
List<? extends com.google.protobuf.ValueOrBuilder>

getParameters()

public Value getParameters()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 3;

Returns
Type Description
Value

The parameters.

getParametersBuilder()

public Value.Builder getParametersBuilder()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 3;

Returns
Type Description
Builder

getParametersOrBuilder()

public ValueOrBuilder getParametersOrBuilder()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 3;

Returns
Type Description
ValueOrBuilder

hasParameters()

public boolean hasParameters()

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 3;

Returns
Type Description
boolean

Whether the parameters field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PredictRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeParameters(Value value)

public PredictRequest.Builder mergeParameters(Value value)

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 3;

Parameter
Name Description
value Value
Returns
Type Description
PredictRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeInstances(int index)

public PredictRequest.Builder removeInstances(int index)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

Parameter
Name Description
index int
Returns
Type Description
PredictRequest.Builder

setEndpoint(String value)

public PredictRequest.Builder setEndpoint(String value)

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

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

Parameter
Name Description
value String

The endpoint to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

setEndpointBytes(ByteString value)

public PredictRequest.Builder setEndpointBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for endpoint to set.

Returns
Type Description
PredictRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setInstances(int index, Value value)

public PredictRequest.Builder setInstances(int index, Value value)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

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

setInstances(int index, Value.Builder builderForValue)

public PredictRequest.Builder setInstances(int index, Value.Builder builderForValue)

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction 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 PredictSchemata's instance_schema_uri.

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

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

setParameters(Value value)

public PredictRequest.Builder setParameters(Value value)

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 3;

Parameter
Name Description
value Value
Returns
Type Description
PredictRequest.Builder

setParameters(Value.Builder builderForValue)

public PredictRequest.Builder setParameters(Value.Builder builderForValue)

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value parameters = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PredictRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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