Class RawPredictRequest.Builder (1.6.0)

public static final class RawPredictRequest.Builder extends GeneratedMessageV3.Builder<RawPredictRequest.Builder> implements RawPredictRequestOrBuilder

Request message for PredictionService.RawPredict.

Protobuf type google.cloud.vertexai.v1.RawPredictRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RawPredictRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RawPredictRequest.Builder
Overrides

build()

public RawPredictRequest build()
Returns
Type Description
RawPredictRequest

buildPartial()

public RawPredictRequest buildPartial()
Returns
Type Description
RawPredictRequest

clear()

public RawPredictRequest.Builder clear()
Returns
Type Description
RawPredictRequest.Builder
Overrides

clearEndpoint()

public RawPredictRequest.Builder clearEndpoint()

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
RawPredictRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RawPredictRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RawPredictRequest.Builder
Overrides

clearHttpBody()

public RawPredictRequest.Builder clearHttpBody()

The prediction input. Supports HTTP headers and arbitrary data payload.

A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model.

You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the Model as a DeployedModel to an Endpoint and use the RawPredict method.

.google.api.HttpBody http_body = 2;

Returns
Type Description
RawPredictRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RawPredictRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RawPredictRequest.Builder
Overrides

clone()

public RawPredictRequest.Builder clone()
Returns
Type Description
RawPredictRequest.Builder
Overrides

getDefaultInstanceForType()

public RawPredictRequest getDefaultInstanceForType()
Returns
Type Description
RawPredictRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getHttpBody()

public HttpBody getHttpBody()

The prediction input. Supports HTTP headers and arbitrary data payload.

A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model.

You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the Model as a DeployedModel to an Endpoint and use the RawPredict method.

.google.api.HttpBody http_body = 2;

Returns
Type Description
com.google.api.HttpBody

The httpBody.

getHttpBodyBuilder()

public HttpBody.Builder getHttpBodyBuilder()

The prediction input. Supports HTTP headers and arbitrary data payload.

A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model.

You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the Model as a DeployedModel to an Endpoint and use the RawPredict method.

.google.api.HttpBody http_body = 2;

Returns
Type Description
com.google.api.HttpBody.Builder

getHttpBodyOrBuilder()

public HttpBodyOrBuilder getHttpBodyOrBuilder()

The prediction input. Supports HTTP headers and arbitrary data payload.

A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model.

You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the Model as a DeployedModel to an Endpoint and use the RawPredict method.

.google.api.HttpBody http_body = 2;

Returns
Type Description
com.google.api.HttpBodyOrBuilder

hasHttpBody()

public boolean hasHttpBody()

The prediction input. Supports HTTP headers and arbitrary data payload.

A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model.

You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the Model as a DeployedModel to an Endpoint and use the RawPredict method.

.google.api.HttpBody http_body = 2;

Returns
Type Description
boolean

Whether the httpBody field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RawPredictRequest other)

public RawPredictRequest.Builder mergeFrom(RawPredictRequest other)
Parameter
Name Description
other RawPredictRequest
Returns
Type Description
RawPredictRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RawPredictRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RawPredictRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RawPredictRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RawPredictRequest.Builder
Overrides

mergeHttpBody(HttpBody value)

public RawPredictRequest.Builder mergeHttpBody(HttpBody value)

The prediction input. Supports HTTP headers and arbitrary data payload.

A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model.

You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the Model as a DeployedModel to an Endpoint and use the RawPredict method.

.google.api.HttpBody http_body = 2;

Parameter
Name Description
value com.google.api.HttpBody
Returns
Type Description
RawPredictRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RawPredictRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RawPredictRequest.Builder
Overrides

setEndpoint(String value)

public RawPredictRequest.Builder setEndpoint(String value)

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

Parameter
Name Description
value String

The endpoint to set.

Returns
Type Description
RawPredictRequest.Builder

This builder for chaining.

setEndpointBytes(ByteString value)

public RawPredictRequest.Builder setEndpointBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for endpoint to set.

Returns
Type Description
RawPredictRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RawPredictRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RawPredictRequest.Builder
Overrides

setHttpBody(HttpBody value)

public RawPredictRequest.Builder setHttpBody(HttpBody value)

The prediction input. Supports HTTP headers and arbitrary data payload.

A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model.

You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the Model as a DeployedModel to an Endpoint and use the RawPredict method.

.google.api.HttpBody http_body = 2;

Parameter
Name Description
value com.google.api.HttpBody
Returns
Type Description
RawPredictRequest.Builder

setHttpBody(HttpBody.Builder builderForValue)

public RawPredictRequest.Builder setHttpBody(HttpBody.Builder builderForValue)

The prediction input. Supports HTTP headers and arbitrary data payload.

A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model.

You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the Model as a DeployedModel to an Endpoint and use the RawPredict method.

.google.api.HttpBody http_body = 2;

Parameter
Name Description
builderForValue com.google.api.HttpBody.Builder
Returns
Type Description
RawPredictRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RawPredictRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RawPredictRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RawPredictRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RawPredictRequest.Builder
Overrides