Class StreamingPredictRequest (1.13.0)

public final class StreamingPredictRequest extends GeneratedMessageV3 implements StreamingPredictRequestOrBuilder

Request message for PredictionService.StreamingPredict.

The first message must contain endpoint field and optionally [input][]. The subsequent messages must contain [input][].

Protobuf type google.cloud.vertexai.v1.StreamingPredictRequest

Static Fields

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

INPUTS_FIELD_NUMBER

public static final int INPUTS_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 StreamingPredictRequest getDefaultInstance()
Returns
Type Description
StreamingPredictRequest

getDescriptor()

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

newBuilder()

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

newBuilder(StreamingPredictRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StreamingPredictRequest getDefaultInstanceForType()
Returns
Type Description
StreamingPredictRequest

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.

getInputs(int index)

public Tensor getInputs(int index)

The prediction input.

repeated .google.cloud.vertexai.v1.Tensor inputs = 2;

Parameter
Name Description
index int
Returns
Type Description
Tensor

getInputsCount()

public int getInputsCount()

The prediction input.

repeated .google.cloud.vertexai.v1.Tensor inputs = 2;

Returns
Type Description
int

getInputsList()

public List<Tensor> getInputsList()

The prediction input.

repeated .google.cloud.vertexai.v1.Tensor inputs = 2;

Returns
Type Description
List<Tensor>

getInputsOrBuilder(int index)

public TensorOrBuilder getInputsOrBuilder(int index)

The prediction input.

repeated .google.cloud.vertexai.v1.Tensor inputs = 2;

Parameter
Name Description
index int
Returns
Type Description
TensorOrBuilder

getInputsOrBuilderList()

public List<? extends TensorOrBuilder> getInputsOrBuilderList()

The prediction input.

repeated .google.cloud.vertexai.v1.Tensor inputs = 2;

Returns
Type Description
List<? extends com.google.cloud.vertexai.api.TensorOrBuilder>

getParameters()

public Tensor getParameters()

The parameters that govern the prediction.

.google.cloud.vertexai.v1.Tensor parameters = 3;

Returns
Type Description
Tensor

The parameters.

getParametersOrBuilder()

public TensorOrBuilder getParametersOrBuilder()

The parameters that govern the prediction.

.google.cloud.vertexai.v1.Tensor parameters = 3;

Returns
Type Description
TensorOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasParameters()

public boolean hasParameters()

The parameters that govern the prediction.

.google.cloud.vertexai.v1.Tensor 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 StreamingPredictRequest.Builder newBuilderForType()
Returns
Type Description
StreamingPredictRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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