Class Extension (3.46.0)

public final class Extension extends GeneratedMessageV3 implements ExtensionOrBuilder

Extensions are tools for large language models to access external data, run computations, etc.

Protobuf type google.cloud.aiplatform.v1beta1.Extension

Implements

ExtensionOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

EXTENSION_OPERATIONS_FIELD_NUMBER

public static final int EXTENSION_OPERATIONS_FIELD_NUMBER
Field Value
Type Description
int

MANIFEST_FIELD_NUMBER

public static final int MANIFEST_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER

public static final int PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RUNTIME_CONFIG_FIELD_NUMBER

public static final int RUNTIME_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

TOOL_USE_EXAMPLES_FIELD_NUMBER

public static final int TOOL_USE_EXAMPLES_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Extension getDefaultInstance()
Returns
Type Description
Extension

getDescriptor()

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

newBuilder()

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

newBuilder(Extension prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this Extension was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Extension was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Extension getDefaultInstanceForType()
Returns
Type Description
Extension

getDescription()

public String getDescription()

Optional. The description of the Extension.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the Extension.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getExtensionOperations(int index)

public ExtensionOperation getExtensionOperations(int index)

Output only. Supported operations.

repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ExtensionOperation

getExtensionOperationsCount()

public int getExtensionOperationsCount()

Output only. Supported operations.

repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getExtensionOperationsList()

public List<ExtensionOperation> getExtensionOperationsList()

Output only. Supported operations.

repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ExtensionOperation>

getExtensionOperationsOrBuilder(int index)

public ExtensionOperationOrBuilder getExtensionOperationsOrBuilder(int index)

Output only. Supported operations.

repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ExtensionOperationOrBuilder

getExtensionOperationsOrBuilderList()

public List<? extends ExtensionOperationOrBuilder> getExtensionOperationsOrBuilderList()

Output only. Supported operations.

repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.ExtensionOperationOrBuilder>

getManifest()

public ExtensionManifest getManifest()

Required. Manifest of the Extension.

.google.cloud.aiplatform.v1beta1.ExtensionManifest manifest = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExtensionManifest

The manifest.

getManifestOrBuilder()

public ExtensionManifestOrBuilder getManifestOrBuilder()

Required. Manifest of the Extension.

.google.cloud.aiplatform.v1beta1.ExtensionManifest manifest = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExtensionManifestOrBuilder

getName()

public String getName()

Identifier. The resource name of the Extension.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the Extension.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPrivateServiceConnectConfig()

public ExtensionPrivateServiceConnectConfig getPrivateServiceConnectConfig()

Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access).

If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution.

.google.cloud.aiplatform.v1beta1.ExtensionPrivateServiceConnectConfig private_service_connect_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExtensionPrivateServiceConnectConfig

The privateServiceConnectConfig.

getPrivateServiceConnectConfigOrBuilder()

public ExtensionPrivateServiceConnectConfigOrBuilder getPrivateServiceConnectConfigOrBuilder()

Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access).

If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution.

.google.cloud.aiplatform.v1beta1.ExtensionPrivateServiceConnectConfig private_service_connect_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExtensionPrivateServiceConnectConfigOrBuilder

getRuntimeConfig()

public RuntimeConfig getRuntimeConfig()

Optional. Runtime config controlling the runtime behavior of this Extension.

.google.cloud.aiplatform.v1beta1.RuntimeConfig runtime_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RuntimeConfig

The runtimeConfig.

getRuntimeConfigOrBuilder()

public RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

Optional. Runtime config controlling the runtime behavior of this Extension.

.google.cloud.aiplatform.v1beta1.RuntimeConfig runtime_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RuntimeConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getToolUseExamples(int index)

public ToolUseExample getToolUseExamples(int index)

Optional. Examples to illustrate the usage of the extension as a tool.

repeated .google.cloud.aiplatform.v1beta1.ToolUseExample tool_use_examples = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ToolUseExample

getToolUseExamplesCount()

public int getToolUseExamplesCount()

Optional. Examples to illustrate the usage of the extension as a tool.

repeated .google.cloud.aiplatform.v1beta1.ToolUseExample tool_use_examples = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getToolUseExamplesList()

public List<ToolUseExample> getToolUseExamplesList()

Optional. Examples to illustrate the usage of the extension as a tool.

repeated .google.cloud.aiplatform.v1beta1.ToolUseExample tool_use_examples = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ToolUseExample>

getToolUseExamplesOrBuilder(int index)

public ToolUseExampleOrBuilder getToolUseExamplesOrBuilder(int index)

Optional. Examples to illustrate the usage of the extension as a tool.

repeated .google.cloud.aiplatform.v1beta1.ToolUseExample tool_use_examples = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ToolUseExampleOrBuilder

getToolUseExamplesOrBuilderList()

public List<? extends ToolUseExampleOrBuilder> getToolUseExamplesOrBuilderList()

Optional. Examples to illustrate the usage of the extension as a tool.

repeated .google.cloud.aiplatform.v1beta1.ToolUseExample tool_use_examples = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.ToolUseExampleOrBuilder>

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this Extension was most recently updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Extension was most recently updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Extension was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasManifest()

public boolean hasManifest()

Required. Manifest of the Extension.

.google.cloud.aiplatform.v1beta1.ExtensionManifest manifest = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the manifest field is set.

hasPrivateServiceConnectConfig()

public boolean hasPrivateServiceConnectConfig()

Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access).

If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution.

.google.cloud.aiplatform.v1beta1.ExtensionPrivateServiceConnectConfig private_service_connect_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the privateServiceConnectConfig field is set.

hasRuntimeConfig()

public boolean hasRuntimeConfig()

Optional. Runtime config controlling the runtime behavior of this Extension.

.google.cloud.aiplatform.v1beta1.RuntimeConfig runtime_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the runtimeConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this Extension was most recently updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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