Class PredictResponse (1.5.0)

public final class PredictResponse extends GeneratedMessageV3 implements PredictResponseOrBuilder

Response message for PredictionService.Predict.

Protobuf type google.cloud.vertexai.v1.PredictResponse

Static Fields

DEPLOYED_MODEL_ID_FIELD_NUMBER

public static final int DEPLOYED_MODEL_ID_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

MODEL_DISPLAY_NAME_FIELD_NUMBER

public static final int MODEL_DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
Type Description
int

MODEL_VERSION_ID_FIELD_NUMBER

public static final int MODEL_VERSION_ID_FIELD_NUMBER
Field Value
Type Description
int

PREDICTIONS_FIELD_NUMBER

public static final int PREDICTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PredictResponse getDefaultInstance()
Returns
Type Description
PredictResponse

getDescriptor()

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

newBuilder()

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

newBuilder(PredictResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PredictResponse getDefaultInstanceForType()
Returns
Type Description
PredictResponse

getDeployedModelId()

public String getDeployedModelId()

ID of the Endpoint's DeployedModel that served this prediction.

string deployed_model_id = 2;

Returns
Type Description
String

The deployedModelId.

getDeployedModelIdBytes()

public ByteString getDeployedModelIdBytes()

ID of the Endpoint's DeployedModel that served this prediction.

string deployed_model_id = 2;

Returns
Type Description
ByteString

The bytes for deployedModelId.

getMetadata()

public Value getMetadata()

Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.

.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Value

The metadata.

getMetadataOrBuilder()

public ValueOrBuilder getMetadataOrBuilder()

Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.

.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ValueOrBuilder

getModel()

public String getModel()

Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.

string model = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The model.

getModelBytes()

public ByteString getModelBytes()

Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.

string model = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for model.

getModelDisplayName()

public String getModelDisplayName()

Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.

string model_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The modelDisplayName.

getModelDisplayNameBytes()

public ByteString getModelDisplayNameBytes()

Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.

string model_display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for modelDisplayName.

getModelVersionId()

public String getModelVersionId()

Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.

string model_version_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The modelVersionId.

getModelVersionIdBytes()

public ByteString getModelVersionIdBytes()

Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.

string model_version_id = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for modelVersionId.

getParserForType()

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

getPredictions(int index)

public Value getPredictions(int index)

The predictions that are the output of the predictions call. The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.

repeated .google.protobuf.Value predictions = 1;

Parameter
Name Description
index int
Returns
Type Description
Value

getPredictionsCount()

public int getPredictionsCount()

The predictions that are the output of the predictions call. The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.

repeated .google.protobuf.Value predictions = 1;

Returns
Type Description
int

getPredictionsList()

public List<Value> getPredictionsList()

The predictions that are the output of the predictions call. The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.

repeated .google.protobuf.Value predictions = 1;

Returns
Type Description
List<Value>

getPredictionsOrBuilder(int index)

public ValueOrBuilder getPredictionsOrBuilder(int index)

The predictions that are the output of the predictions call. The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.

repeated .google.protobuf.Value predictions = 1;

Parameter
Name Description
index int
Returns
Type Description
ValueOrBuilder

getPredictionsOrBuilderList()

public List<? extends ValueOrBuilder> getPredictionsOrBuilderList()

The predictions that are the output of the predictions call. The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.

repeated .google.protobuf.Value predictions = 1;

Returns
Type Description
List<? extends com.google.protobuf.ValueOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMetadata()

public boolean hasMetadata()

Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.

.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the metadata 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 PredictResponse.Builder newBuilderForType()
Returns
Type Description
PredictResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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