public static final class PredictRequest.Builder extends GeneratedMessageV3.Builder<PredictRequest.Builder> implements PredictRequestOrBuilder
Request message for PredictionService.Predict.
Protobuf type google.cloud.aiplatform.v1beta1.PredictRequest
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
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];
| Name | Description |
| values | Iterable<? extends com.google.protobuf.Value>
|
Returns
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];
| Name | Description |
| value | Value
|
Returns
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];
| Name | Description |
| builderForValue | Builder
|
Returns
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];
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];
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];
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];
public PredictRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public PredictRequest build()
Returns
public PredictRequest buildPartial()
Returns
public PredictRequest.Builder clear()
Returns
Overrides
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) = { ... }
public PredictRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
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];
public PredictRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
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;
public PredictRequest.Builder clone()
Returns
Overrides
public PredictRequest getDefaultInstanceForType()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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) = { ... }
| Type | Description |
| String | The endpoint.
|
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) = { ... }
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];
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];
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];
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];
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];
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];
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];
| Type | Description |
| List<? extends com.google.protobuf.ValueOrBuilder> | |
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;
| Type | Description |
| Value | The parameters.
|
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;
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;
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;
| Type | Description |
| boolean | Whether the parameters field is set.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public PredictRequest.Builder mergeFrom(PredictRequest other)
Parameter
Returns
public PredictRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public PredictRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
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;
| Name | Description |
| value | Value
|
Returns
public final PredictRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
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];
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) = { ... }
| Name | Description |
| value | String
The endpoint to set.
|
Returns
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) = { ... }
| Name | Description |
| value | ByteString
The bytes for endpoint to set.
|
Returns
public PredictRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
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];
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];
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;
| Name | Description |
| value | Value
|
Returns
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;
| Name | Description |
| builderForValue | Builder
|
Returns
public PredictRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final PredictRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
