Class AIInference (1.145.0)

public final class AIInference extends GeneratedMessageV3 implements AIInferenceOrBuilder

Configuration for making inference requests against Vertex AI models.

Protobuf type google.pubsub.v1.AIInference

Static Fields

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

UNSTRUCTURED_INFERENCE_FIELD_NUMBER

public static final int UNSTRUCTURED_INFERENCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AIInference getDefaultInstance()
Returns
Type Description
AIInference

getDescriptor()

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

newBuilder()

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

newBuilder(AIInference prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public AIInference getDefaultInstanceForType()
Returns
Type Description
AIInference

getEndpoint()

public String getEndpoint()

Required. An endpoint to a Vertex AI model of the form projects/{project}/locations/{location}/endpoints/{endpoint} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}. Vertex AI API requests will be sent to this endpoint.

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The endpoint.

getEndpointBytes()

public ByteString getEndpointBytes()

Required. An endpoint to a Vertex AI model of the form projects/{project}/locations/{location}/endpoints/{endpoint} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}. Vertex AI API requests will be sent to this endpoint.

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for endpoint.

getInferenceModeCase()

public AIInference.InferenceModeCase getInferenceModeCase()
Returns
Type Description
AIInference.InferenceModeCase

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccountEmail()

public String getServiceAccountEmail()

Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

getUnstructuredInference()

public AIInference.UnstructuredInference getUnstructuredInference()

Optional. Requests and responses can be any arbitrary JSON object.

.google.pubsub.v1.AIInference.UnstructuredInference unstructured_inference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AIInference.UnstructuredInference

The unstructuredInference.

getUnstructuredInferenceOrBuilder()

public AIInference.UnstructuredInferenceOrBuilder getUnstructuredInferenceOrBuilder()

Optional. Requests and responses can be any arbitrary JSON object.

.google.pubsub.v1.AIInference.UnstructuredInference unstructured_inference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AIInference.UnstructuredInferenceOrBuilder

hasUnstructuredInference()

public boolean hasUnstructuredInference()

Optional. Requests and responses can be any arbitrary JSON object.

.google.pubsub.v1.AIInference.UnstructuredInference unstructured_inference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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