Package com.google.cloud.aiplatform.v1beta1

Class Extension

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.Extension
All Implemented Interfaces:
ExtensionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Extension extends com.google.protobuf.GeneratedMessage implements ExtensionOrBuilder
 Extensions are tools for large language models to access external data, run
 computations, etc.
Protobuf type google.cloud.aiplatform.v1beta1.Extension
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • MANIFEST_FIELD_NUMBER

      public static final int MANIFEST_FIELD_NUMBER
      See Also:

    • EXTENSION_OPERATIONS_FIELD_NUMBER

      public static final int EXTENSION_OPERATIONS_FIELD_NUMBER
      See Also:

    • RUNTIME_CONFIG_FIELD_NUMBER

      public static final int RUNTIME_CONFIG_FIELD_NUMBER
      See Also:

    • TOOL_USE_EXAMPLES_FIELD_NUMBER

      public static final int TOOL_USE_EXAMPLES_FIELD_NUMBER
      See Also:

    • PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER

      public static final int PRIVATE_SERVICE_CONNECT_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Identifier. The resource name of the Extension.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface ExtensionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name of the Extension.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface ExtensionOrBuilder
      Returns:
      The bytes for name.

    • 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];
      Specified by:
      getDisplayName in interface ExtensionOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.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];
      Specified by:
      getDisplayNameBytes in interface ExtensionOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. The description of the Extension.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface ExtensionOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The description of the Extension.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface ExtensionOrBuilder
      Returns:
      The bytes for description.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this Extension was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ExtensionOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when this Extension was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ExtensionOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when this Extension was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ExtensionOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface ExtensionOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when this Extension was most recently updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface ExtensionOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when this Extension was most recently updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface ExtensionOrBuilder

    • 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];
      Specified by:
      getEtag in interface ExtensionOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.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];
      Specified by:
      getEtagBytes in interface ExtensionOrBuilder
      Returns:
      The bytes for etag.

    • hasManifest

      public boolean hasManifest()
       Required. Manifest of the Extension.
      .google.cloud.aiplatform.v1beta1.ExtensionManifest manifest = 9 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasManifest in interface ExtensionOrBuilder
      Returns:
      Whether the manifest field is set.

    • getManifest

      public ExtensionManifest getManifest()
       Required. Manifest of the Extension.
      .google.cloud.aiplatform.v1beta1.ExtensionManifest manifest = 9 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getManifest in interface ExtensionOrBuilder
      Returns:
      The manifest.

    • getManifestOrBuilder

      public ExtensionManifestOrBuilder getManifestOrBuilder()
       Required. Manifest of the Extension.
      .google.cloud.aiplatform.v1beta1.ExtensionManifest manifest = 9 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getManifestOrBuilder in interface ExtensionOrBuilder

    • getExtensionOperationsList

      public List<ExtensionOperation> getExtensionOperationsList()
       Output only. Supported operations.
      repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExtensionOperationsList in interface ExtensionOrBuilder

    • 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];
      Specified by:
      getExtensionOperationsOrBuilderList in interface ExtensionOrBuilder

    • getExtensionOperationsCount

      public int getExtensionOperationsCount()
       Output only. Supported operations.
      repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExtensionOperationsCount in interface ExtensionOrBuilder

    • getExtensionOperations

      public ExtensionOperation getExtensionOperations(int index)
       Output only. Supported operations.
      repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExtensionOperations in interface ExtensionOrBuilder

    • getExtensionOperationsOrBuilder

      public ExtensionOperationOrBuilder getExtensionOperationsOrBuilder(int index)
       Output only. Supported operations.
      repeated .google.cloud.aiplatform.v1beta1.ExtensionOperation extension_operations = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExtensionOperationsOrBuilder in interface ExtensionOrBuilder

    • 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];
      Specified by:
      hasRuntimeConfig in interface ExtensionOrBuilder
      Returns:
      Whether the runtimeConfig field is set.

    • 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];
      Specified by:
      getRuntimeConfig in interface ExtensionOrBuilder
      Returns:
      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];
      Specified by:
      getRuntimeConfigOrBuilder in interface ExtensionOrBuilder

    • 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];
      Specified by:
      getToolUseExamplesList in interface ExtensionOrBuilder

    • 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];
      Specified by:
      getToolUseExamplesOrBuilderList in interface ExtensionOrBuilder

    • 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];
      Specified by:
      getToolUseExamplesCount in interface ExtensionOrBuilder

    • getToolUseExamples

      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];
      Specified by:
      getToolUseExamples in interface ExtensionOrBuilder

    • getToolUseExamplesOrBuilder

      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];
      Specified by:
      getToolUseExamplesOrBuilder in interface ExtensionOrBuilder

    • 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];
      Specified by:
      hasPrivateServiceConnectConfig in interface ExtensionOrBuilder
      Returns:
      Whether the privateServiceConnectConfig field is set.

    • 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];
      Specified by:
      getPrivateServiceConnectConfig in interface ExtensionOrBuilder
      Returns:
      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];
      Specified by:
      getPrivateServiceConnectConfigOrBuilder in interface ExtensionOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Extension parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Extension parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Extension parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Extension parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Extension parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Extension parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Extension parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Extension parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Extension parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Extension parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Extension parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Extension parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Extension.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Extension.Builder newBuilder()

    • newBuilder

      public static Extension.Builder newBuilder(Extension prototype)

    • toBuilder

      public Extension.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Extension.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Extension getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Extension> parser()

    • getParserForType

      public com.google.protobuf.Parser<Extension> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Extension getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder