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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
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];
| Parameter |
| Name |
Description |
values |
Iterable<? extends com.google.protobuf.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
|
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
|
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
|
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
|
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];
| Parameter |
| Name |
Description |
index |
int
|
public PredictRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public PredictRequest build()
public PredictRequest buildPartial()
public PredictRequest.Builder clear()
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)
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 clearLabels()
public PredictRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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()
Overrides
public boolean containsLabels(String key)
Optional. The user labels for Imagen billing usage only. Only Imagen
supports labels. For other use cases, it will be ignored.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
public PredictRequest getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
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) = { ... }
| Returns |
| 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for endpoint.
|
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 |
|
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
|
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];
| Returns |
| Type |
Description |
int |
|
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];
| Parameter |
| Name |
Description |
index |
int
|
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> |
|
public Map<String,String> getLabels()
public int getLabelsCount()
Optional. The user labels for Imagen billing usage only. Only Imagen
supports labels. For other use cases, it will be ignored.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getLabelsMap()
Optional. The user labels for Imagen billing usage only. Only Imagen
supports labels. For other use cases, it will be ignored.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
public String getLabelsOrDefault(String key, String defaultValue)
Optional. The user labels for Imagen billing usage only. Only Imagen
supports labels. For other use cases, it will be ignored.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
public String getLabelsOrThrow(String key)
Optional. The user labels for Imagen billing usage only. Only Imagen
supports labels. For other use cases, it will be ignored.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
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.
|
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;
| Returns |
| Type |
Description |
boolean |
Whether the parameters field is set.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public PredictRequest.Builder mergeFrom(PredictRequest other)
public PredictRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public PredictRequest.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
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;
| Parameter |
| Name |
Description |
value |
Value
|
public final PredictRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public PredictRequest.Builder putAllLabels(Map<String,String> values)
Optional. The user labels for Imagen billing usage only. Only Imagen
supports labels. For other use cases, it will be ignored.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
public PredictRequest.Builder putLabels(String key, String value)
Optional. The user labels for Imagen billing usage only. Only Imagen
supports labels. For other use cases, it will be ignored.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
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
|
public PredictRequest.Builder removeLabels(String key)
Optional. The user labels for Imagen billing usage only. Only Imagen
supports labels. For other use cases, it will be ignored.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
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.
|
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.
|
public PredictRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
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];
| Parameters |
| Name |
Description |
index |
int
|
value |
Value
|
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
|
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
|
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
|
public PredictRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public final PredictRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
