JavaAppResource

Handle

📦 Aspire.Hosting.Java v13.6.5-preview.1.26559.7

interface JavaAppResource
  extends IComputeResource,
    IContainerFilesDestinationResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IResourceWithServiceDiscovery,
    IJavaAppResource {
  withGradleBuild(args: string[]): JavaAppResource;
  withGradleTask(
      task: string,
      args: string[]): JavaAppResource;
  withJarArtifact(jarPath: string): JavaAppResource;
  withMainClass(mainClass: string): JavaAppResource;
  withMavenBuild(args: string[]): JavaAppResource;
  withMavenGoal(
      goal: string,
      args: string[]): JavaAppResource;
  withOtelAgent(agentPath: string): JavaAppResource;
  withOtelAgentDefaultPath(): JavaAppResource;
  withWrapperPath(wrapperPath: string): JavaAppResource;
}

9 members

Methods

methodwithGradleBuildbuilder

Runs a Gradle build before the Java application starts.

withGradleBuild(args: string[]): JavaAppResource

Parameters

argsstring[]Arguments passed to the Gradle wrapper. Defaults to `clean build`.

Returns

JavaAppResource

methodwithGradleTaskbuilder

Launches the Java application through a Gradle task instead of `java`, for example `bootRun`.

withGradleTask(
    task: string,
    args: string[]): JavaAppResource

Parameters

taskstringThe Gradle task to execute.

argsstring[]Additional arguments passed to the Gradle wrapper after the task.

Returns

JavaAppResource

methodwithJarArtifactbuilder

Selects the JAR the generated container image runs, for projects whose build produces more than one.

withJarArtifact(jarPath: string): JavaAppResource

Parameters

jarPathstringThe path to the JAR produced by the build, relative to the application directory, for example `target/app.jar`.

Returns

JavaAppResource

methodwithMainClassbuilder

Sets the main class an IDE launches when running or debugging this application. Has no effect on how Aspire starts the process, which is decided by the JAR path, Maven goal, or Gradle task.

withMainClass(mainClass: string): JavaAppResource

Parameters

mainClassstringThe fully qualified name of the class declaring `main`, for example `com.example.Application`.

Returns

JavaAppResource

methodwithMavenBuildbuilder

Runs a Maven build before the Java application starts.

withMavenBuild(args: string[]): JavaAppResource

Parameters

argsstring[]Arguments passed to the Maven wrapper. Defaults to `clean package`.

Returns

JavaAppResource

methodwithMavenGoalbuilder

Launches the Java application through a Maven goal instead of `java`, for example `spring-boot:run`.

withMavenGoal(
    goal: string,
    args: string[]): JavaAppResource

Parameters

goalstringThe Maven goal to execute.

argsstring[]Additional arguments passed to the Maven wrapper after the goal.

Returns

JavaAppResource

methodwithOtelAgentbuilder

Runs the application with the OpenTelemetry Java agent so it exports traces, metrics, and logs to Aspire.

withOtelAgent(agentPath: string): JavaAppResource

Parameters

agentPathstringThe path to the `opentelemetry-javaagent.jar` file.

Returns

JavaAppResource

methodwithOtelAgentDefaultPathbuilder

Runs the application with the OpenTelemetry Java agent from the location the build tool writes it to.

withOtelAgentDefaultPath(): JavaAppResource

Returns

JavaAppResource

methodwithWrapperPathbuilder

Overrides the build tool wrapper script path, for repositories whose wrapper is not in the default location or does not use the default name.

withWrapperPath(wrapperPath: string): JavaAppResource

Parameters

wrapperPathstringThe path to the wrapper script, absolute or relative to the resource's working directory.

Returns

JavaAppResource