ElasticsearchResource Class

Definition

Namespace:: Aspire.Hosting.ApplicationModel

Assembly:: Aspire.Hosting.Elasticsearch.dll

Package:: Aspire.Hosting.Elasticsearch v8.2.2-preview.1.24521.5

Source:: ElasticsearchResource.cs

Source:: ElasticsearchResource.cs

Source:: ElasticsearchResource.cs

Source:: ElasticsearchResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A resource that represents a Elasticsearch

public class ElasticsearchResource : Aspire.Hosting.ApplicationModel.ContainerResource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString

type ElasticsearchResource = class
    inherit ContainerResource
    interface IResourceWithConnectionString
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences

Public Class ElasticsearchResource
Inherits ContainerResource
Implements IResourceWithConnectionString

Inheritance: Object

Resource

ContainerResource
ElasticsearchResource

Implements: IManifestExpressionProvider IResource IResourceWithConnectionString IValueProvider IValueWithReferences

Constructors

Name	Description
ElasticsearchResource(String, ParameterResource)	A resource that represents a Elasticsearch

Properties

Name	Description
Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConnectionStringExpression	Gets the connection string expression for the Elasticsearch
Entrypoint	The container Entrypoint. (Inherited from ContainerResource)
InternalEndpoint	Gets the internal endpoint for the Elasticsearch. This endpoint used for communications between nodes in a cluster
Name	Gets the name of the resource. (Inherited from Resource)
PasswordParameter	Gets the parameter that contains the Elasticsearch superuser password.
PrimaryEndpoint	Gets the primary endpoint for the Elasticsearch. This endpoint is used for all API calls over HTTP.

Extension Methods

Name	Description
GetConnectionProperty(IResourceWithConnectionString, String)	Retrieves the value of a specified connection property from the resource's connection properties.
GetEndpoint(IResourceWithEndpoints, String)	Gets an endpoint reference for the specified endpoint name.
GetEndpoints(IResourceWithEndpoints)	Gets references to all endpoints for the specified resource.
GetEnvironmentVariableValuesAsync(IResourceWithEnvironment, DistributedApplicationOperation)	Obsolete. Get the environment variables from the given resource.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
IsContainer(IResource)	Determines whether the specified resource is a container resource.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, CancellationToken)	Obsolete. Processes argument values for the specified resource in the given execution context.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)	Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, CancellationToken)	Obsolete. Processes environment variable values for the specified resource within the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
RequiresImageBuild(IResource)	Determines whether the specified resource requires image building.
ResolveEndpoints(IResource, IPortAllocator)	Resolves endpoint port configuration for the specified resource. Computes target ports and exposed ports based on resource type, endpoint configuration, and whether the endpoint is considered a default HTTP endpoint.
TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource.
TryGetContainerImageName(IResource, Boolean, String)	Attempts to get the container image name from the given resource.
TryGetContainerImageName(IResource, String)	Attempts to get the container image name from the given resource.
TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)	Attempts to get the container mounts for the specified resource.
TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)	Attempts to retrieve the endpoints for the given resource.
TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)	Attempts to get the environment variables from the given resource.
TryGetLastAnnotation<T>(IResource, T)	Attempts to get the last annotation of the specified type from the resource.

Applies to

Feedback

Was this page helpful?