Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

SolrResource

Handle
📦 CommunityToolkit.Aspire.Hosting.Solr v13.6.1

Represents an Apache Solr container resource.

type SolrResource interface {
ExpressionValue
IComputeResource
Resource
ResourceWithArgs
ResourceWithConnectionString
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string expression for the Solr server.
ConnectionStringExpression() *ReferenceExpression
propertyCoreNamestringget · set
The Solr core name.
CoreName() (string, error)
SetCoreName(value string) SolrResource
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for this resource.
Host() EndpointReferenceExpression
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for this resource.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the primary endpoint for the Solr server.
PrimaryEndpoint() EndpointReference
propertyUriExpression*ReferenceExpressionget
Gets the connection URI expression for the Solr server.
UriExpression() *ReferenceExpression

Methods

methodWithConfigsetbuilder
Specifies the path to the config set directory.
WithConfigset(
configSetName string,
configSetPath string,
) SolrResource
configSetNamestringThe name of the config set.
configSetPathstringPath to the config set directory.
SolrResource

An IResourceBuilder that can be used to further customize the resource.

Returns a handle; failures surface later via Err().

methodWithDataBindMountbuilder
Adds a bind mount for the data folder to a Solr container resource.
WithDataBindMount(
source string,
options ...*WithDataBindMountOptions,
) SolrResource
sourcestringThe source directory on the host to mount into the container.
options...*WithDataBindMountOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataBindMountOptions argument.

IsReadOnly*boolA flag that indicates if this is a read-only mount.
SolrResource

The IResourceBuilder.

Returns a handle; failures surface later via Err().

methodWithDataVolumebuilder
Adds a named volume for the data folder to a Solr container resource.
WithDataVolume(options ...*WithDataVolumeOptions) SolrResource
options...*WithDataVolumeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataVolumeOptions argument.

Name*stringThe name of the volume. Defaults to an auto-generated name based on the application and resource names.
IsReadOnly*boolA flag that indicates if this is a read-only volume.
SolrResource

The IResourceBuilder.

Returns a handle; failures surface later via Err().