Class PredictRequest (1.5.0)

public final class PredictRequest extends GeneratedMessageV3 implements PredictRequestOrBuilder

Request message for PredictionService.Predict.

Protobuf type google.cloud.vertexai.v1.PredictRequest

Static Fields

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PredictRequest getDefaultInstance()
Returns
Type Description
PredictRequest

getDescriptor()

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

newBuilder()

public static PredictRequest.Builder newBuilder()
Returns
Type Description
PredictRequest.Builder

newBuilder(PredictRequest prototype)

public static PredictRequest.Builder newBuilder(PredictRequest prototype)
Parameter
Name Description
prototype PredictRequest
Returns
Type Description
PredictRequest.Builder

parseDelimitedFrom(InputStream input)

public static PredictRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PredictRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PredictRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PredictRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PredictRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PredictRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PredictRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PredictRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PredictRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PredictRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PredictRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PredictRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PredictRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PredictRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PredictRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PredictRequest> parser()
Returns
Type Description
Parser<PredictRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PredictRequest getDefaultInstanceForType()
Returns
Type Description
PredictRequest

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

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.

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

getParserForType()

public Parser<PredictRequest> getParserForType()
Returns
Type Description
Parser<PredictRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PredictRequest.Builder newBuilderForType()
Returns
Type Description
PredictRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PredictRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PredictRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PredictRequest.Builder toBuilder()
Returns
Type Description
PredictRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException