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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EXTENSION_OPERATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MANIFEST_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RUNTIME_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOL_USE_EXAMPLES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Extension getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Extension.Builder newBuilder()
public static Extension.Builder newBuilder(Extension prototype)
| Parameter |
| Name |
Description |
prototype |
Extension
|
public static Extension parseDelimitedFrom(InputStream input)
public static Extension parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Extension parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static Extension parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Extension parseFrom(ByteString data)
public static Extension parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Extension parseFrom(CodedInputStream input)
public static Extension parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Extension parseFrom(InputStream input)
public static Extension parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Extension parseFrom(ByteBuffer data)
public static Extension parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Extension> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Extension was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Extension getDefaultInstanceForType()
public String getDescription()
Optional. The description of the Extension.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
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.
|
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.
|
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.
|
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.
|
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
|
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];
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
|
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> |
|
public ExtensionManifest getManifest()
Required. Manifest of the Extension.
.google.cloud.aiplatform.v1beta1.ExtensionManifest manifest = 9 [(.google.api.field_behavior) = REQUIRED];
public ExtensionManifestOrBuilder getManifestOrBuilder()
Required. Manifest of the Extension.
.google.cloud.aiplatform.v1beta1.ExtensionManifest manifest = 9 [(.google.api.field_behavior) = REQUIRED];
Identifier. The resource name of the Extension.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
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.
|
public Parser<Extension> getParserForType()
Overrides
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];
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];
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];
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];
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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
|
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 |
|
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];
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
|
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> |
|
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.
|
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];
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.
|
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.
|
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.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Extension.Builder newBuilderForType()
protected Extension.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public Extension.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
