public final class PredictRequest extends GeneratedMessageV3 implements PredictRequestOrBuilder
Request message for
PredictionService.Predict.
Protobuf type google.cloud.aiplatform.v1beta1.PredictRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ENDPOINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INSTANCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static PredictRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static PredictRequest.Builder newBuilder()
public static PredictRequest.Builder newBuilder(PredictRequest prototype)
public static PredictRequest parseDelimitedFrom(InputStream input)
public static PredictRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PredictRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static PredictRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PredictRequest parseFrom(ByteString data)
public static PredictRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictRequest parseFrom(CodedInputStream input)
public static PredictRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PredictRequest parseFrom(InputStream input)
public static PredictRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PredictRequest parseFrom(ByteBuffer data)
public static PredictRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<PredictRequest> parser()
Methods
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 boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public PredictRequest getDefaultInstanceForType()
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 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 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 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 Parser<PredictRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
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.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public PredictRequest.Builder newBuilderForType()
protected PredictRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public PredictRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
