GarnetResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Garnet / GarnetResource

GarnetResource

Docs Reference TypeScript APIs Aspire.Hosting.Garnet GarnetResource

Handle TypeScript

📦 Aspire.Hosting.Garnet v13.2.0-preview.1.26159.1

interface GarnetResource
  extends IComputeResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  entrypoint: string;
  readonly host: EndpointReferenceExpression;
  readonly name: string;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  readonly uriExpression: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): GarnetResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): GarnetResource;
  withPersistence(interval?: timespan): GarnetResource;
}

Implements

• IComputeResource
• IManifestExpressionProvider
• IResource
• IResourceWithArgs
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IValueProvider
• IValueWithReferences

Search members of GarnetResource…

method property

13 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property entrypoint string get · set

Gets the Entrypoint property

property host EndpointReferenceExpression get

Gets the Host property

property name string get

Gets the Name property

property port EndpointReferenceExpression get

Gets the Port property

property primaryEndpoint EndpointReference get

Gets the PrimaryEndpoint property

property shellExecution boolean get · set

Gets the ShellExecution property

property uriExpression ReferenceExpression get

Gets the UriExpression property

Methods

method withDataBindMount builder

Mounts a host directory as the Garnet data directory.

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

Parameters

source string

isReadOnly boolean optional = False

Returns

GarnetResource

method withDataVolume builder

Adds a persistent data volume to the Garnet resource.

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

Parameters

name string optional

isReadOnly boolean optional = False

Returns

GarnetResource

method withPersistence builder

Configures snapshot persistence for the Garnet resource.

withPersistence(interval?: timespan): GarnetResource

Parameters

interval timespan optional

Returns

GarnetResource