com.google.cloud.aiplatform.v1

Interface PredictRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PredictRequest, PredictRequest.Builder

@Generated
public interface PredictRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
String	getEndpoint() Required.
com.google.protobuf.ByteString	getEndpointBytes() Required.
com.google.protobuf.Value	getInstances(int index) 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.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
com.google.protobuf.Value	getParameters() The parameters that govern the prediction.
com.google.protobuf.ValueOrBuilder	getParametersOrBuilder() The parameters that govern the prediction.
boolean	hasParameters() The parameters that govern the prediction.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getEndpoint

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:

The endpoint.

getEndpointBytes

com.google.protobuf.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:

The bytes for endpoint.

getInstancesList

List<com.google.protobuf.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][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];

getInstances

com.google.protobuf.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][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];

getInstancesCount

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][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];

getInstancesOrBuilderList

List<? extends com.google.protobuf.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][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

com.google.protobuf.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][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

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 = 3;

Returns:

Whether the parameters field is set.

getParameters

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 = 3;

Returns:

The parameters.

getParametersOrBuilder

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 = 3;

getLabelsCount

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];

containsLabels

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];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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];

getLabelsOrDefault

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];

getLabelsOrThrow

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];