org.eclipse.aether.deployment

## Class DeployRequest

- java.lang.Object
- - org.eclipse.aether.deployment.DeployRequest

-     public final class DeployRequest
      extends Object

  A request to deploy artifacts and their accompanying metadata into the a remote repository.
  See Also:
    `RepositorySystem.deploy(RepositorySystemSession, DeployRequest)`

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `DeployRequest()` Creates an uninitialized request.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `DeployRequest` | `addArtifact(Artifact artifact)` Adds the specified artifacts for deployment.
    `DeployRequest` | `addMetadata(Metadata metadata)` Adds the specified metadata for deployment.
    `Collection<Artifact>` | `getArtifacts()` Gets the artifact to deploy.
    `Collection<Metadata>` | `getMetadata()` Gets the metadata to deploy.
    `RemoteRepository` | `getRepository()` Gets the repository to deploy to.
    `RequestTrace` | `getTrace()` Gets the trace information that describes the higher level request/operation in which this request is issued.
    `DeployRequest` | `setArtifacts(Collection<Artifact> artifacts)` Sets the artifacts to deploy.
    `DeployRequest` | `setMetadata(Collection<Metadata> metadata)` Sets the metadata to deploy.
    `DeployRequest` | `setRepository(RemoteRepository repository)` Sets the repository to deploy to.
    `DeployRequest` | `setTrace(RequestTrace trace)` Sets the trace information that describes the higher level request/operation in which this request is issued.
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### DeployRequest

          public DeployRequest()

      Creates an uninitialized request.

  - ### Method Detail

    - #### getArtifacts

          public Collection<Artifact> getArtifacts()

      Gets the artifact to deploy.
      Returns:
        The artifacts to deploy, never `null`.

    - #### setArtifacts

          public DeployRequest setArtifacts(Collection<Artifact> artifacts)

      Sets the artifacts to deploy.
      Parameters:
        `artifacts` - The artifacts to deploy, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### addArtifact

          public DeployRequest addArtifact(Artifact artifact)

      Adds the specified artifacts for deployment.
      Parameters:
        `artifact` - The artifact to add, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### getMetadata

          public Collection<Metadata> getMetadata()

      Gets the metadata to deploy.
      Returns:
        The metadata to deploy, never `null`.

    - #### setMetadata

          public DeployRequest setMetadata(Collection<Metadata> metadata)

      Sets the metadata to deploy.
      Parameters:
        `metadata` - The metadata to deploy, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### addMetadata

          public DeployRequest addMetadata(Metadata metadata)

      Adds the specified metadata for deployment.
      Parameters:
        `metadata` - The metadata to add, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### getRepository

          public RemoteRepository getRepository()

      Gets the repository to deploy to.
      Returns:
        The repository to deploy to or `null` if not set.

    - #### setRepository

          public DeployRequest setRepository(RemoteRepository repository)

      Sets the repository to deploy to.
      Parameters:
        `repository` - The repository to deploy to, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### getTrace

          public RequestTrace getTrace()

      Gets the trace information that describes the higher level request/operation in which this request is issued.
      Returns:
        The trace information about the higher level operation or `null` if none.

    - #### setTrace

          public DeployRequest setTrace(RequestTrace trace)

      Sets the trace information that describes the higher level request/operation in which this request is issued.
      Parameters:
        `trace` - The trace information about the higher level operation, may be `null`.
      Returns:
        This request for chaining, never `null`.

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2010-2013 The Eclipse Foundation. All Rights Reserved.