MilvusServerResource

Handle

📦 Aspire.Hosting.Milvus v13.4.0

interface MilvusServerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly apiKeyParameter: ParameterResource;
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  readonly host: EndpointReferenceExpression;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly token: ReferenceExpression;
  readonly uriExpression: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): MilvusDatabaseResource;
  withAttu(configureContainer?: (obj: AttuResource) => Promise<void>, containerName?: string): MilvusServerResource;
  withConfigurationFile(configurationFilePath: string): MilvusServerResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): MilvusServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): MilvusServerResource;
}

13 members

Properties

property apiKeyParameter ParameterResource get

Gets the parameter that contains the Milvus API key.

property connectionStringExpression ReferenceExpression get

Gets the connection string expression for the Milvus gRPC endpoint.

property databases Dict<string,string> get

A dictionary where the key is the resource name and the value is the database name.

property host EndpointReferenceExpression get

Gets the host endpoint reference for this resource.

property port EndpointReferenceExpression get

Gets the port endpoint reference for this resource.

property primaryEndpoint EndpointReference get

Gets the gRPC endpoint for the Milvus database.

property token ReferenceExpression get

Gets a valid access token to access the Milvus instance.

property uriExpression ReferenceExpression get

Gets URI expression for the Milvus instance.

Methods

method addDatabase builder

Adds a Milvus database to the application model.

addDatabase(
    name: string,
    databaseName?: string): MilvusDatabaseResource

Parameters

name string

databaseName string optional

Returns

MilvusDatabaseResource

method withAttu builder

Adds an administration and development platform for Milvus to the application model using Attu.

withAttu(configureContainer?: (obj: AttuResource) => Promise<void>, containerName?: string): MilvusServerResource

Parameters

configureContainer (obj: AttuResource) => Promise<void> optional

containerName string optional

Returns

MilvusServerResource

method withConfigurationFile builder

Copies a configuration file into a Milvus container resource.

withConfigurationFile(configurationFilePath: string): MilvusServerResource

Parameters

configurationFilePath string

Returns

MilvusServerResource

method withDataBindMount builder

Adds a bind mount for the data folder to a Milvus container resource.

withDataBindMount(
    source: string,
    isReadOnly?: boolean): MilvusServerResource

Parameters

source string

isReadOnly boolean optional = False

Returns

MilvusServerResource

method withDataVolume builder

Adds a named volume for the data folder to a Milvus container resource.

withDataVolume(
    name?: string,
    isReadOnly?: boolean): MilvusServerResource

Parameters

name string optional

isReadOnly boolean optional = False

Returns

MilvusServerResource