com.google.cloud.aiplatform.v1beta1

Class PredictRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.PredictRequest

All Implemented Interfaces:

PredictRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PredictRequest
extends com.google.protobuf.GeneratedMessageV3
implements PredictRequestOrBuilder

 Request message for [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict].
 

Protobuf type google.cloud.aiplatform.v1beta1.PredictRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PredictRequest.Builder Request message for [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENDPOINT_FIELD_NUMBER
static int	INSTANCES_FIELD_NUMBER
static int	PARAMETERS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static PredictRequest	getDefaultInstance()
PredictRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Value	getParameters() The parameters that govern the prediction.
com.google.protobuf.ValueOrBuilder	getParametersOrBuilder() The parameters that govern the prediction.
com.google.protobuf.Parser<PredictRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasParameters() The parameters that govern the prediction.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PredictRequest.Builder	newBuilder()
static PredictRequest.Builder	newBuilder(PredictRequest prototype)
PredictRequest.Builder	newBuilderForType()
protected PredictRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PredictRequest	parseDelimitedFrom(InputStream input)
static PredictRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(byte[] data)
static PredictRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(ByteBuffer data)
static PredictRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(com.google.protobuf.ByteString data)
static PredictRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static PredictRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(InputStream input)
static PredictRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PredictRequest>	parser()
PredictRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER

See Also:

Constant Field Values

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER

See Also:

Constant Field Values

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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) = { ... }

Specified by:

getEndpoint in interface PredictRequestOrBuilder

Returns:

The endpoint.

getEndpointBytes

public 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) = { ... }

Specified by:

getEndpointBytes in interface PredictRequestOrBuilder

Returns:

The bytes for endpoint.

getInstancesList

public 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.v1beta1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstancesList in interface PredictRequestOrBuilder

getInstancesOrBuilderList

public 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.v1beta1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstancesOrBuilderList in interface PredictRequestOrBuilder

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][google.cloud.aiplatform.v1beta1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstancesCount in interface PredictRequestOrBuilder

getInstances

public 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.v1beta1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstances in interface PredictRequestOrBuilder

getInstancesOrBuilder

public 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.v1beta1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
 

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInstancesOrBuilder in interface PredictRequestOrBuilder

hasParameters

public 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.v1beta1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 3;

Specified by:

hasParameters in interface PredictRequestOrBuilder

Returns:

Whether the parameters field is set.

getParameters

public 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.v1beta1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 3;

Specified by:

getParameters in interface PredictRequestOrBuilder

Returns:

The parameters.

getParametersOrBuilder

public 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.v1beta1.DeployedModel.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value parameters = 3;

Specified by:

getParametersOrBuilder in interface PredictRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PredictRequest parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static PredictRequest parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static PredictRequest parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static PredictRequest parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static PredictRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static PredictRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public PredictRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PredictRequest.Builder newBuilder()

newBuilder

public static PredictRequest.Builder newBuilder(PredictRequest prototype)

toBuilder

public PredictRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PredictRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PredictRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<PredictRequest> parser()

getParserForType

public com.google.protobuf.Parser<PredictRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public PredictRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder